v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

OAuth

Obtain/Refresh Tokens

This endpoint is used to obtain a new access token using various OAuth 2.0 grant types or refresh an existing token.

post/oauth/authorizations

client_idstring required

The unique identifier for the client application requesting the token.

client_secretstring required

The secret key associated with the client application, used for authentication.

grant_type'authorization_code' | 'refresh_token' required

The OAuth 2.0 grant type. Possible values: 'authorization_code' or 'refresh_token'.

codestring

The authorization code received from the authorization endpoint. Required if 'grant_type' is 'authorization_code'.

refresh_tokenstring

The refresh token used to obtain a new access token. Required if 'grant_type' is 'refresh_token'.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

{
  "error_msg": "Done."
}