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


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