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/screens" 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/screens" rel="nofollow noopener noreferrer" target="_blank">Fetch screen content</a>

Meanwhile, User-level API keys serve other purposes.

The User API key is only available if there is at least 1 device in the account with a Developer edition license.

Generate a User API Key from your account tab: ​<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/plugin-data" 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/plugin-data" 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 employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

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.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

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?