API keys
Get an API key
Returns a single API key's metadata by its id. The secret is never
returned. Unknown ids, or ids that belong to another organization, return
404 NOT_FOUND.
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
Path Parameters
id*string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/api-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"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
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "validation failed",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM",
"details": {
"to": "must be E.164",
"body": "must be 1..1600 chars"
}
}
}{
"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": "NOT_FOUND",
"message": "not found",
"request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
}
}