Sign in
API Tokens

Get API token

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

get/iam/clients/{clientId}/tokens/{tokenId}

Path parameters

clientIdinteger required

Account ID.

tokenIdinteger required

API token ID.

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"
}

Changes

Changed in 2 of the 29 revisions of this API.3

  • eb97fe6d936e1See the full diff
    • ○

      endpoint deprecated

      endpoint-deprecated

  • a02801156a6a2See the full diff
    • ○

      added Token-2 to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed schemas-Token from the response body allOf list for the response status 200

      response-body-all-of-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog