Skip to main content
The Admin API lets you manage your Tranthor workspace programmatically. Use it from your own scripts and services, or from an AI agent that can make HTTP requests. Its endpoints are prefixed with /api/admin. Unlike the /api/public endpoints, which use a write key, Admin API endpoints require an Admin API key. With it you can work with your segments, journeys, message templates, user properties, users, events, and broadcasts. See the API Reference tab for every endpoint.

​
Create an Admin API key

Create keys on the settings page, under Admin API Key. Once an Admin API key is created, its value can’t be read again. Make sure to copy it and store it securely, for example in a secrets manager. If you lose it, delete the key and create a new one.

​
Find your workspace ID

Every Admin API request also has to say which workspace it is for. Your workspace ID is shown under Workspace Metadata on the settings page.

​
Make a request

Send the Admin API key in the Authorization header, and include the workspace ID as workspaceId. Each endpoint’s reference page shows where it goes: in the query string for reads, and in the JSON body for writes.
A request with a missing or invalid key returns 401. A missing or malformed workspace ID returns 400.
An Admin API key can change your whole workspace. Keep it out of browsers, mobile apps, and source control. For sending events from your app, use the public write key instead.