Get Access Token

Get Access Token

Notice

This is not the method used to generate an Access Token, this method is only for getting information about an existing Access Token you already have access to. To obtain an Access Token see Process Authentication
This method returns information about an existing Access Token you already have access to.
Parameter NameDefault ValueRequiredDescription
application_idNULLTrueThe ID of the Application
secret_keyNULLTrueThe Application's Secret Key
access_tokenNULLTrueThe Access Token to get information about

Example Success Response

This response is returned when the request was successful
{
  "success": true,
  "response_code": 200,
  "results": {
    "granted_permissions": [
      "READ_PERSONAL_INFORMATION",
      "INVOKE_TELEGRAM_NOTIFICATIONS",
      "READ_EMAIL_ADDRESS",
      "READ_TELEGRAM_CLIENT",
      "READ_TODO",
      "MANAGE_TODO",
      "SYNC_APPLICATION_SETTINGS",
      "READ_USERNAME",
      "GET_USER_DISPLAY"
    ],
    "expires_timestamp": 1608439904
  }
}

Example Not Found Response

This response is returned when you provide a Access Token which doesn't exist or you don't have access to.
{
  "success": false,
  "response_code": 401,
  "error": {
    "error_code": 25,
    "message": "ACCESS DENIED, INCORRECT ACCESS TOKEN",
    "type": "COA"
  }
}

Access Token Response Structure

NameTypeDescription
access_tokenstringThe Access Token allowing you to have access to the users account.
granted_permissionsstring[]A array of permissions that the User granted to the Application
expires_timestampintegerThe Unix Timestamp for when this access token expires

Application Permissions

To get more information about what permissions a Application can use and what do they mean, see Application Permissions. Note that the user can deny certain permissions that your Application requests, so for example if you request the ability to view the users Email Address then the user can deny that request but still authenticate to your Application.