TRMNL

TRMNL's most popular API endpoints require a device-level token, which you can retrieve for any Developer edition enabled device from <a href="https://usetrmnl.com/devices" rel="nofollow noopener noreferrer" target="_blank">Devices &gt; Edit</a> &gt; Developer Perks.

A device-level access token may be used to:

Send webhooks to a <a href="https://help.usetrmnl.com/en/articles/9510536-private-plugins">Private plugin</a> / Recipe

<a href="https://docs.usetrmnl.com/go/private-api/fetch-screen-content" rel="nofollow noopener noreferrer" target="_blank">Fetch screen content</a>

- Send webhooks to a <a href="https://help.usetrmnl.com/en/articles/9510536-private-plugins">Private plugin</a> / Recipe
- <a href="https://docs.usetrmnl.com/go/private-api/fetch-screen-content" rel="nofollow noopener noreferrer" target="_blank">Fetch screen content</a>

Meanwhile, User-level API keys serve other purposes.

Generate a User API Key from your account tab:<br><a href="https://usetrmnl.com/account" rel="nofollow noopener noreferrer" target="_blank">https://usetrmnl.com/account</a>

A user-level access token may be used to:

<a href="https://docs.usetrmnl.com/go/private-api/fetch-plugin-content" rel="nofollow noopener noreferrer" target="_blank">Fetch plugin content</a> (Data Mode)

Run local dev tools like <a href="https://github.com/usetrmnl/trmnlp" rel="nofollow noopener noreferrer" target="_blank">trmnlp</a>

<a href="https://help.usetrmnl.com/en/articles/10542599-importing-and-exporting-private-plugins">Export private plugins</a> to a zip file (for backup or sharing)

- <a href="https://docs.usetrmnl.com/go/private-api/fetch-plugin-content" rel="nofollow noopener noreferrer" target="_blank">Fetch plugin content</a> (Data Mode)
- Run local dev tools like <a href="https://github.com/usetrmnl/trmnlp" rel="nofollow noopener noreferrer" target="_blank">trmnlp</a>
- <a href="https://help.usetrmnl.com/en/articles/10542599-importing-and-exporting-private-plugins">Export private plugins</a> to a zip file (for backup or sharing)

In the future, User API Keys will be able to access other account-level endpoints such as <code>/devices</code>, <code>/playlists</code>, and more.

Features and tools that require this token.

User level API Keys

Find answers and get help from Intercom Support and Community Experts

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

Link, Press control-option-right-arrow to exit

Empty Help Center

Uh oh. That page doesn’t exist.

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

User level API Keys

Where is my User API Key?

What can a User API Key do?