Sign in

v1

latestOpenAPI 3.0.32026-07-268955212.1 KB
authorization

Obtain access token

OAuth 2.0 token endpoint to exchange authorization code for access token, request token with client credentials, or refresh an existing token.

  • Use Authorization Code grant to obtain access token for a Company to use with the Company API.
  • Use Refresh Token grant to obtain a new access token using a refresh token.
  • Use Client Credentials grant to obtain access token for the General API.
post/token

Response

OK

tenant_idstring uuid

The id for the tenant that for this token. This field will be empty when the tenant_type is general

tenant_type'general' | 'company'

The type of tenant that for this token.

access_tokenstring
token_typestring
expires_ininteger
refresh_tokenstring

Returned for authorization_code and refresh_token grant types. The client_credentials grant expected that refresh are done by making another /token request with client_credentials grant.

connection_idstring uuid

The id for the connection that for this token. This field will be empty when the tenant_type is general