Get an API key
Settings module
GET/api-keys/{id}apiKeys.get
An org-scoped API key with capability scopes and expiry. The secret is shown once and stored hashed. Returns one API key with its `ETag`. A API key the caller may not see returns 404.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the api key. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: ApiKey
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the api key. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | Key name.Constraints: length 1 to 300 |
| service_account_id | string (uuid) | null | Yes | Identifier of the service account. |
| scopes | array of string | Yes | Capability groups the key may use. |
| expires_at | string (date-time) | Yes | Expiry. |
| prefix | string | Yes | Visible key prefix.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| last_used_at | string (date-time) | null | Yes | Last use. |
| revoked_at | string (date-time) | null | Yes | When it was revoked. |
| revoked_by | string (uuid) | null | Yes | Identifier of the person who revoked the key. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Accounting Sync",
"service_account_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"scopes": [
"finance"
],
"expires_at": "2026-10-08T14:30:00Z",
"prefix": "xos_live_7Hq2",
"last_used_at": "2026-10-08T14:30:00Z",
"revoked_at": "2026-10-08T14:30:00Z",
"revoked_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/api-keys/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.apiKeys.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.api_keys.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos api-keys get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f