Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
API Tokens

List API tokens

Deprecated: This endpoint will be removed on 2026-07-17. Use GET /v2/clients/{clientId}/tokens instead.

Get information about your permanent API tokens in the account. A user with the Administrators role gets information about all API tokens in the account.

get/iam/clients/{clientId}/tokens

Path parameters

clientIdinteger required

Account ID.

Query parameters

rolestring

Group's ID. Possible values are:

  • 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only (API+Web)* 3022 - Purge and Prefetch only (API)

Example, &role=Engineers

issued_byinteger

User's ID. Use to get API tokens issued by a particular user.
Example, &issued_by=1234

not_issued_byinteger

User's ID. Use to get API tokens issued by anyone except a particular user.
Example, ¬_issued_by=1234

deletedboolean

The state of API tokens included in the response.
Two possible values:

  • True - API token was not deleted.* False - API token was deleted.

Example, &deleted=True

Response

OK.

namestring required

API token name.

descriptionstring

API token description.

exp_datestring nullable required

Date when the API token becomes expired (ISO 8086/RFC 3339 format), UTC. If null, then the API token will never expire.

idinteger required

API token ID.

deletedboolean required

Deletion flag. If true, then the API token was deleted.

expiredboolean required

Expiration flag. If true, then the API token has expired. When an API token expires it will be automatically deleted.

createdstring required

Date when the API token was issued (ISO 8086/RFC 3339 format), UTC.

last_usagestring required

Date when the API token was last used (ISO 8086/RFC 3339 format), UTC.

Example response

[
  {
    "name": "My token",
    "description": "It's my token",
    "exp_date": "2021-01-01T12:00:00.000000Z",
    "client_user": {
      "role": {
        "id": 1,
        "name": "Administrators"
      },
      "user_id": 123,
      "user_name": "John Doe",
      "user_email": "some@email.com",
      "client_id": 456
    },
    "id": 42,
    "created": "2021-01-01T12:00:00.000000Z",
    "last_usage": "2021-01-01T12:00:00.000000Z"
  }
]