Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Tokens

Create a token

Create an authentication token for a client application installation.

⚠️ Endpoint is available only in the Customer interface.

⚠️ When creating a new token, the request does not need to contain an Authentication header.

⚠️ We highly recommend filling all identifications in the tokens resource (device and application) to avoid problems if multiple applications use the CareCloud REST API on one device.

What happens when a token is created

  • A token record is created and its server-generated token_id is returned.
  • The token is bound to the supplied device identification and setup parameters (language, GPS permission, notifications permission).
  • The token is used as the credential on subsequent customer-interface requests, sent as Authorization: Bearer <token_id>. See Authentication for the full flow.
post/tokens

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Request body

external_application_idstring required

ID of the external application. More information about external applications and how to get an ID is available in Authentication section

push_tokenstring

Push notification token (Apple or Google).

Example request

{
  "device": {
    "device_id": "00000000-89ABCDEF-01234567-89ABCDEF",
    "device_system": "OSX",
    "device_name": "Test device",
    "device_type": "iPhone"
  },
  "setup": {
    "language_id": "en",
    "allowed_gps": true
  },
  "external_application_id": "82de12eb8b138791e678fd11c3",
  "push_token": "4f7f658bfa7a5959e093590"
}

Response

Created

Example response

{
  "data": {
    "token_id": "4d8121dea8ae3c7b7fc66e6924ecc466dc7aa13e299ac757d87533ab2630f31bd906aadf"
  }
}