Page tree
Skip to end of metadata
Go to start of metadata

Create access token

Returns an access token to API 3 for a specific person. Read the documentation of API 3 for how to use the access token. The access token is valid for one week but it's recommended to generate a new each day.

Request

POST:APIURL/generateapi3token.json
apikey=338934897438

Parameters

Name

Value

Description

Data type

Default

personid

personid=4

The ID of the person to generate the access token for. Must and should only be provided when using API key level 3.

ID

 

 

Response

Tag

Example

Data type

Description

token_type

Bearer

String

Is always "Bearer"

access_tokeneyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3OTcyNjAxMjQsInN1YiI6Ijc5IiwicHJpbmNpcGFs...StringThe access token to use when requesting protected resources in API 3
personid4IDID of person that the token was generated for
{
  "token_type": "Bearer",
  "access_token": "eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3OTcyNjAxMjQsInN1YiI6Ijc5IiwicHJpbmNpcGFs...",  // Cropped. Usually contains more than 600 chars
  "personid": 4
}
  • No labels