Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Tokens

Get authentication token that allows customer to log in or verified in other applications.

This endpoint returns an authentication token. Another application that uses the CareCloud API can use this token to verify the customer or sign the customer in. Typical uses include redirecting a logged-in customer from one app to another, or completing sign-in in an in-app browser for a different application or portal. ⚠️ Endpoint is available only in Customer interface.

get/tokens/{token_id}/actions/auth-token

Path parameters

token_idstring required

A client application token.

Query parameters

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

Parameter set witch token type should be generated. Possible values: 1- alphanumeric, 2- numeric

Headers

Accept-Languagestring

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

Response

OK

Example response

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