Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Customers

Get information about all customer partners

Get a list of customer partners in CareCloud.

Customer-partner relations define which partners (retail chains, brands, or business units) a customer account is associated with. A customer can be assigned to one or more partners. This assignment determines which partner's loyalty programs, communications, and rewards are applicable to the customer.

⚠️ Endpoint is available only in the Enterprise interface.

get/customers/{customer_id}/partner-records

Path parameters

customer_idstring required

The unique ID of the customer.

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": {
    "partner_records": [
      {
        "partner_record_id": "88bd53f8ac5f3b595d6bc106a4",
        "partner_id": "86e05affc7a7abefcd513ab400"
      }
    ],
    "total_items": 1
  }
}