latestOpenAPI 3.0.0Private2026-08-1081731.5 KB

170261dc1673

OAuth2

Check Short Code

Check the status of a short code that was generated, retrieving auth credentials if it's been redeemed and device_id matches

post/v2/oauth/checkshortcode

Request body

device_idstring required

The device_id returned from the creation of a short code

codestring required

The short code

Response

Success

refresh_tokenstring required

The refresh token which can be used to retrieve new access tokens

access_tokenstring required

The access token which is used as a bearer token in the Authorization header

access_token_expires_atstring date-time required

The date and time when the access token expires and is no longer valid

scopesstring[] required

A list of scopes that this token has access to

users_idinteger required

The identifier for the user this token is for

apps_idinteger required

When the token is scoped, the identifier for the app that the token is scoped to

client_idstring required

The id of the API client this token is issued for

refresh_token_expires_atstring date-time required

The date and time when the refresh token is no longer valid.

Example response

{
  "access_token_expires_at": "1970-04-20 07:10:00+00",
  "refresh_token_expires_at": "1970-04-20 07:10:00+00"
}