Customer external applications

You can get the list of the available customer external applications here.

Available methods

All available methods for resource customer-external-applications.

HTTP method Endpoint Description
[badge-blue GET] /customer-external-applications Get information about all customer external applications
[badge-blue GET] /customer-external-applications/{customer_external_application_id} Get information about specific customer external application

Get all customer external applications

Get a list of customer external applications accepted in CRM CareCloud
[badge-blue GET ] /customer-external-applications

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
customer_external_applications ExternalApplication[] List of the customer external applications
total_items integer Count of all found customer external applications

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/customer-external-applications?count=2
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZWgEmEyZGFjZ3NmUzNDljNGYyMzlkOWQ0NA==

Example response

HTTP/1.1 200 OK
Date: Wed, 21 Apr 2021 13:36:34 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "customer_external_applications": [
      {
        "external_application_id": "89d1a6111b3fb6e74665d948",
        "name": "mobile app",
        "state": 1,
        "last_change": "2020-07-01 14:04:25"
      },
      {
        "external_application_id": "87d706e4864d02f7ce201c58",
        "name": "web shop",
        "state": 1,
        "last_change": "2020-12-03 14:19:50"
      }
    ],
    "total_items": 8
  }
}


Detail of a customer external application

Get information about a specific customer external application
[badge-blue GET] /customer-external-applications/{customer_external_application_id}

Path parameters

Parameter name Type Description
customer_external_application_id string The unique id of a customer external application in CareCloud

Response

Status code: 200 OK
Output structure : ExternalApplication

Example request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/customer-external-applications/81eaeea13b894a169c490a325
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZWgEmEyZGFjZ3NmUzNDljNGYyMzlkOWNA==

Example response

HTTP/1.1 200 OK
Date: Wed, 21 Apr 2021 13:39:53 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "external_application_id": "89d1a6111b3fb6e746865d948",
    "name": "mobile app",
    "state": 1,
    "last_change": "2020-07-01 14:04:25"
  }
}