Get all customer external applications
Get a list of customer external applications accepted in the CareCloud platform.
External applications are third-party or in-house systems registered to interact with the CareCloud API on behalf of customers. They are used for generating authentication tokens and managing push notification registrations. Use the returned IDs in authentication token and push notification requests.
Related: POST /customers/actions/auth-token (enterprise interface only), POST /customers/actions/set-push-notifications (enterprise interface only)
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
Filter by one value or a list of external application text IDs. The list of values is available at GET /customer-external-applications. In case you want to filter multiple options use array syntax: text_id[]=sandbox_app&text_id[]=other_app Logic OR is used between values.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"customer_external_applications": [
{
"external_application_id": "8bed991c68a470e7aaeffbf048",
"text_id": "sandbox_app",
"name": "Sandbox app",
"last_change": "2021-07-26 09:46:59.005819",
"state": 1
}
],
"total_items": 1
}
}