v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
API Keys

List API keys

List and filter API keys.

get/api_keys

Query parameters

limitinteger
Example:25
starting_afterstring uuid
Example:9007b3b2-2c77-49c3-a3be-e71eab300a68

The ID of the object from which your list request will start. It is not included in the result.

start_datestring date
Example:2025-07-08

The creation date of the API key.

end_datestring date
Example:2025-07-08

The creation date of the API key.

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

The permission of the API key.

last_4_charsstring
Example:2d06

The last 4 characters of the API key.

disabledboolean

The disabled status of the API key.

Response

List of filtered API keys.

Example response

{
  "records": [
    {
      "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"
    }
  ]
}