API keys

Manage SuperSend TX API keys from the public API (Bearer auth with a full-scope key) or the dashboard.

Base URL: https://api.supersendtx.com

Scopes

Scope	Access
`full` (default)	Domains, webhooks, keys, emails
`sending`	`POST/GET /emails` only

List

GET /api-keys?limit=25&cursor=…

{
  "data": [
    {
      "id": "…",
      "name": "Default",
      "scope": "full",
      "prefix": "stx_abcd",
      "created_at": "2026-07-26T00:00:00.000Z",
      "last_used_at": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Create

POST /api-keys

{ "name": "CI", "scope": "sending" }

Response (token shown once):

{
  "id": "…",
  "name": "CI",
  "scope": "sending",
  "prefix": "stx_…",
  "token": "stx_…",
  "created_at": "2026-07-26T00:00:00.000Z"
}

Delete

DELETE /api-keys/{id} → { "ok": true }

Cannot delete the key authenticating the request.

SDK / CLI

await client.apiKeys.create({ name: 'CI', scope: 'sending' })
await client.apiKeys.list()
await client.apiKeys.remove(id)

supersendtx keys create --name CI --scope sending
supersendtx keys list
supersendtx keys delete --id <id>