TRMNL API
HomeBuy a Device
  • 👋Overview
  • How it Works
  • Private Plugins
    • Screen Templating
    • Screen Templating (Graphics)
    • Create a screen
  • DIY TRMNL (Advanced)
    • Introduction
    • BYOD
    • BYOD/S
    • BYOS
  • ImageMagick Guide
  • Plugin Marketplace
    • Introduction
    • Plugin Creation
    • Plugin Installation Flow
    • Plugin Management Flow
    • Plugin Screen Generation Flow
    • Plugin Uninstallation Flow
    • Going Live
  • Private API
    • Introduction
    • Fetch Screen Content
    • Fetch Plugin Content
    • Account API
  • Partners API
    • Introduction
    • Getting Started
    • Provisioning Devices
Powered by GitBook
On this page
  • Authentication
  • Example
  1. Private API

Account API

Control aspects of your usetrmnl.com account

PreviousFetch Plugin ContentNextIntroduction

Last updated 21 hours ago

In addition to the , users who have purchased a developer license can access the account API. You can enumerate your devices, import and export plugins, control playlists, and more.

See the for complete details.

We have also open-sourced an official Ruby gem for API clients.

These endpoints are being continually improved upon as we discover new use-cases, so please send us feedback with your API feature requests.

Authentication

The account API key can be retrieved from . It begins with user_.

API authentication is done via the HTTP Authorization header with bearer tokens, e.g. Authorization: Bearer user_xxxxx

Example

// GET https://usetrmnl.com/api/devices

{
  "data": [
    {
      "id": 123456,
      "name": "My TRMNL",
      "friendly_id": "A1B2C3",
      "mac_address": "AB:CD:EF:12:34:56",
      "battery_voltage": 3.9,
      "rssi": -41
    }
  ]
}
device API
OpenAPI specification
trmnl-api
your account settings