Customer types

You can get the list of the available customer types here.

Available methods

All available methods for resource customer types.

HTTP method Endpoint Description
[badge-blue GET] /customer-types Get information about all customer types
[badge-blue GET] /customer-types/{customer_type_id} Get information about specific customer type

Get all customer types

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

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_types Customer-type[] List of the customer types
total_items integer Count of all found customer types

Example request

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

Example response

HTTP/1.1 200 OK
Date: Tue, 04 Aug 2020 10:51:36 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "customer_types": [
      {
        "type_id": "86e05affc7a7abefcd513ab400",
        "name": "club",
        "last_change": "2017-12-01 14:29:41"
      },
      {
        "type_id": "8bed991c68a470e7aaeffbf048",
        "name": "non club",
        "last_change": "2017-12-15 08:36:29"
      },
      {
        "type_id": "81eaeea13b8984a169c490a325",
        "name": "others",
        "last_change": "2017-12-15 08:36:29"
      }
    ],
    "total_items": 3
  }
}


Detail of a customer type

Get information about a specific customer type
[badge-blue GET] /customer-types/{customer_type_id}

Path parameters

Parameter name Type Description
customer_type_id string The unique id of a customer type in CareCloud

Response

Status code: 200 OK
Output structure : CustomerType

Example request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/customer-types/86e05afc7a7abefcd513ab400
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmU2ZTBkMjg4MDllMzM3ZDdjNGEmEGFjZ3NmUzNDljNGYyMzlkOWEwZmQyM2Q0NA==

Example response

HTTP/1.1 200 OK
Date: Tue, 04 Aug 2020 12:11:16 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "type_id": "86e05afc7a7abefcd513ab400",
    "name": "Club",
    "last_change": "2017-12-01 14:29:41"
  }
}