v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Customer relation types

Get all customer relation types

Get a list of customer relation types from CareCloud.

Customer relation types define the categories of relationships that can exist between customer accounts - for example, household members, referral relationships, or account groupings. Use the returned IDs when creating related customer records.

get/customer-relation-types

Query parameters

countinteger

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.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

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.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

Headers

Accept-Languagestring

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

Response

OK

Example response

{
  "data": {
    "customer_relation_types": [
      {
        "customer_relation_type_id": "8bed991c68a470e7aaeffbf048",
        "name": "Family account",
        "last_change": "2019-05-16 13:35:40",
        "state": 1
      }
    ],
    "total_items": 1
  }
}