Skip to main content
POST
Request an access token

Body

multipart/form-data
username
string
required

Username (usually your email address) to authenticate.

password
string
required

Password associated with the username for authentication.

grant_type
enum<string>
default:password

Grant type for the authentication flow. This value is hardcoded as 'password'.

Available options:
password
format
enum<string>
default:json

Response format. This value is hardcoded as 'json'.

Available options:
json

Response

Successful authentication returns an access token and refresh token.

access_token
string

Access token for the authenticated session.

refresh_token
string

Refresh token for renewing the session.

expires_in
integer

Time in seconds until the access token expires.

token_type
string

Type of token issued. Usually 'Bearer'.

scope
string

Granted scopes for the access token, e.g., 'offline_access'.

Example:

"offline_access"