v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Customers actions

Get authentication token for a customer

Returns an authentication token for a specific customer. Another application that uses the CareCloud API can use this token to verify the customer's identity or authenticate the customer.

Typical uses include initiating customer sign-in in another application or portal, or passing a customer's identity to an in-app browser for a different application.

⚠️ Endpoint is available only in the Enterprise interface.

post/customers/actions/auth-token

Headers

Accept-Languagestring

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

Request body

customer_idstring required

The unique ID of the customer. GET /customers

external_application_idstring required

ID of the destination external application. Please provide the destination external application ID, not the token-issuing external application ID. Need a destination external application ID? Please contact your CareCloud administrator.

token_type1 | 2 required

Sets which token type should be generated. Possible values: 1 - alphanumeric, 2 - numeric

Example request

{
  "customer_id": "8ea2591121e636086a4a9c0992",
  "external_application_id": "82de12eb8b138791e678fd11c3",
  "token_type": 2
}

Response

Example response

{
  "data": {
    "authentication_token": "LQ55EH",
    "token_request_id": "6fb977c6fce6da6c0fa32aa1bc6417c621c116c65a5d638fefac1488334d67e33867675d",
    "valid_to": "2019-01-04 10:31:56"
  }
}