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_preview)

Preview Intercom API version. Used for closed beta endpoints or other features under managed availability.

Default:"Preview"

Value:"Preview"

Example:Preview

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

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_atstring or null

The time the credential was created, as an ISO 8601 timestamp.

Example:"2025-11-15T09:30:00Z"

updated_atstring or null

The time the credential was last updated, as an ISO 8601 timestamp.

Example:"2026-01-20T14:22:15Z"

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": "2025-11-15T09:30:00Z",
  "updated_at": "2026-01-20T14:22:15Z"
}