Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
API Keys

Retrieve API key

Retrieve the details of a specific API key.

get/api_keys/{id}

Path parameters

idstring uuid required
Example:9007b3b2-2c77-49c3-a3be-e71eab300a68

The ID of the API key.

Response

Successfully retrieved API key.

idstring uuid required

The ID of the API key.

namestring required

The name of the API key.

emailstring required

The email linked to the API key.

permission'read' | 'modify' | 'write' required

The permission of the API key.

last_4_charsstring required

The last 4 characters of the API key.

expiration_datestring required

The UTC timestamp when the API key will expire.

created_atstring date-time required

The UTC timestamp when the API key was created.

disabled_atstring required

The UTC timestamp when the API key was disabled.

Example response

{
  "id": "9007b3b2-2c77-49c3-a3be-e71eab300a68",
  "name": "My API key",
  "email": "example@numeral.io",
  "permission": "read",
  "last_4_chars": "2d06",
  "expiration_date": "2025-07-08T08:50:51.974246244Z",
  "created_at": "2025-07-08T08:50:51.974246244Z",
  "disabled_at": "2025-07-08T08:50:51.974246244Z"
}