API status
  • Authentication

Access Tokens

All authentication related paths.

post

Get an access token for requested scopes

Get an access token to use with the API with specified scopes.

You should always scope your access tokens. You get one for read-access and separate ones for updating, creating or deleting resources.

client_idstring

required

Client ID given during onboarding.

Format
uuid
client_secretstring

required

Client Secret given during onboarding.

Max Length
1000
grant_typestring

required

This must always be client_credentials.

Default
"client_credentials"
scopestring

required

List of space delimited scopes to request for this access token.

Max Length
1000

Responses

Request examples

{
  "client_id": "363f3305-7ab0-4e82-a158-f9d382ad08b6",
  "client_secret": "WHIW1yic-ouct3sceh",
  "grant_type": "client_credentials",
  "scope": "users:read"
}

Response examples

Access token successfully generated.

{
  "access_token": "token.signature",
  "expires_in": 86400,
  "token_type": "bearer",
  "scope": "users:read"
}

Was this page helpful?