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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The unique ID of the customer. GET /customers

string
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.

integer
enum
required
Defaults to 1

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

Allowed:
Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json