View Source

Get information on the specified AccessToken.

Access tokens can be used for managing more secure access to the APIs. For more information, see API Authentication.
Access tokens can be created via the or via API. For more information on creating via API, see API AccessTokens Create v4.

Version: v4

Required Permissions

Request

Request Type: GET

Endpoint:

/v4/apiAccessTokens/<id>

where:

Parameter	Description
`<id>`	The `tokenId` value for the access token

Request URI - Example:

/v4/apiAccessTokens/0bc1d49f-5475-4c62-a0ba-6ad269389ada

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

NOTE: If you receive a Route doesn't exist error message, please verify that the API access token feature has been enabled in your instance of the platform. For more information, see Enable API Access Tokens.

Response Body Example:

{
    "tokenId": "0bc1d49f-5475-4c62-a0ba-6ad269389ada",
    "description": "new token",
    "expiredAt": "2020-01-15T20:58:28.175Z",
    "lastUsed": null,
    "createdAt": "2019-01-15T20:58:28.175Z"
}

Reference

Property Description

tokenId

Internal identifier for the token.

NOTE: This value is unique within the instance of the platform.

description User-friendly description for the access token

expiredAt

Timestamp for when the access token expires.

A null value indicates that the access token never expires.

lastUsed

Timestamp for when the access token was last used.

A null value indicates that the access token has never been used.

createdAt Timestamp for when the access token was created