Servers
More ways to use this page
Read a server
GET/v1/
TypeScript account
Python account
Key ak_… an account key
Parameters
idin pathstring (uuid)requiredThe server id.
Responses
200A server of the account: an isolation boundary with its own keys, streams, log, suppressions and webhooks.
serverIdstring (uuid)requiredThe id every server key, stream and message of the server refers to.
namestring (at least 1, at most 100 characters)requiredThe name given at creation, unique within the account.
mode"live" | "test"requiredlive delivers; test goes through everything but delivery, so nothing reaches a recipient. Fixed when the server is created.
createdAtstring (date-time)required
Example
{
"serverId": "7c1e4d2a-0b9f-4a3e-8d6c-5e2f1a9b8c70",
"name": "Invoicing",
"mode": "live",
"createdAt": "2026-09-20T12:00:00.000Z"
}Errors
Every error answers error, the code, and message, a sentence for a person. A code that adds fields is shown in full below the table.
| Code | Status | Meaning |
|---|---|---|
unauthorized | 401 | The key is missing, malformed or revoked. |
wrong_ | 403 | The key is of the other kind: a server key (sk_) where an account key (ak_) is needed, or the reverse. The message names the kind the operation takes. |
not_ | 404 | No such server of this account. |