Retrieve an auth token

Request

Returns the metadata for a single stored third-party credential. A credential that the list endpoint does not return is also not retrievable here, and responds with 404.

Security

bearerAuth

Path

idstringrequired

The unique identifier for the auth token.

Example:12345

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.18

curl -i -X GET \
  https://api.intercom.io/auth_tokens/12345 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.18'

Responses

successful

Bodyapplication/json

typestring

The type of object - auth_token.

Value:"auth_token"

Example:"auth_token"

idstring

The unique identifier for the auth token.

Example:"12345"

namestring or null

The name given to the credential when it was created.

Example:"Fulfilment API key"

descriptionstring or null

An optional description of what the credential is used for.

Example:"Used by the order status connector"

token_typestring or null

How the credential is presented to the external API, for example as a header value or an HMAC signature.

Example:"text"

request_header_keystring or null

The request header the credential is sent in.

Example:"Authorization"

token_prefixstring or null

The prefix placed before the credential value in the header, for example Bearer.

Example:"Bearer"

domainstring or null

The domain the credential is scoped to, if one was set.

Example:"api.fulfilment.example.com"

created_atinteger or null

The time the credential was created as a Unix timestamp.

Example:1763199000

updated_atinteger or null

The time the credential was last updated as a Unix timestamp.

Example:1768918935

Response

{
  "type": "auth_token",
  "id": "12345",
  "name": "Fulfilment API key",
  "description": "Used by the order status connector",
  "token_type": "text",
  "request_header_key": "Authorization",
  "token_prefix": "Bearer",
  "domain": "api.fulfilment.example.com",
  "created_at": 1763199000,
  "updated_at": 1768918935
}