AgentMessage
API keys

List API keys

GET
/v1/api-keys

Returns your organization's API keys, newest first, with cursor pagination. Only metadata is returned (id, label, prefix, scopes, created_at, last_used_at, revoked_at); the secret is never shown again after a key is created.

Revoked keys are included by default so you can show a revocation history. Pass include_revoked=false to hide them.

Requires the apikeys:read scope.

AuthorizationBearer <token>

Authenticate by sending your API key as a bearer token: Authorization: Bearer am_live_.... Every request is automatically scoped to the organization that owns the key and to the scopes granted to that key.

In: header

Query Parameters

cursor?string
limit?integer
Default50
Range1 <= value <= 100
include_revoked?boolean
Defaulttrue

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/api-keys"
{
  "success": true,
  "data": [
    {
      "id": "0190a1b2-c3d4-e5f6-a7b8-c9d0e1f2a3b4",
      "org_id": "0190a1b2-c3d4-e5f6-a7b8-c9d0e1f2a3b5",
      "label": "order-confirmations bot",
      "prefix": "am_live_oc01",
      "scopes": [
        "messages:send"
      ],
      "created_at": "2026-04-26T12:00:00Z",
      "last_used_at": "2026-04-26T13:42:11Z",
      "revoked_at": null
    },
    {
      "id": "0190a1b2-c3d4-e5f6-a7b8-c9d0e1f2a3b6",
      "org_id": "0190a1b2-c3d4-e5f6-a7b8-c9d0e1f2a3b5",
      "label": "legacy webhook bot",
      "prefix": "am_live_lwb1",
      "scopes": [
        "messages:send",
        "messages:read"
      ],
      "created_at": "2026-03-01T08:30:00Z",
      "last_used_at": "2026-03-30T22:11:09Z",
      "revoked_at": "2026-04-15T17:00:00Z"
    }
  ],
  "meta": {
    "total": 0,
    "limit": 50,
    "offset": 0,
    "next_cursor": null
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "authentication failed",
    "request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
  }
}
{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "missing required scope",
    "request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
  }
}
{
  "success": false,
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "validation failed",
    "request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM",
    "details": {
      "to": "must be E.164",
      "body": "must be 1..1600 chars"
    }
  }
}