Skip to main content
POST
/
oauth
/
token
Exchange ID/Secret for a token
curl --request POST \
  --url https://{base_url}/api/v1/oauth/token \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "grant_type": "client_credentials"
}
'
{
  "__type": "SSJSON_Token_Access",
  "access_token": "<string>",
  "expires_in": 3600,
  "refresh_token": "<string>",
  "scope": "read",
  "token_type": "Bearer"
}

Authorizations

​
Authorization
string
header
required

Pass your client ID as the username and your client secret as the password. These are used only to obtain a bearer token from /oauth/token.

Body

application/json
​
grant_type
string
required

The type of grant being requested. Must always be client_credentials.

Example:

"client_credentials"

Response

Token issued successfully

​
__type
string

Internal type identifier

Example:

"SSJSON_Token_Access"

​
access_token
string

The bearer token to use in subsequent API requests

​
expires_in
integer

Seconds until the token expires. This will always be 3600.

Example:

3600

​
refresh_token
string

Token that can be used to refresh the session

​
scope
string

The permission scope granted

Example:

"read"

​
token_type
string

The token type. Will always be Bearer.

Example:

"Bearer"