Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Customers

Get customer source records

Get information about all customer account source records.

Customer source records identify the external systems or applications where the customer account is tracked - for example, a mobile application, e-commerce platform, or POS system. Each record links the customer to a customer source and can include one or more external IDs used by that source system.

When both the external_ids and external_id filter parameters are provided, external_ids takes priority and external_id is ignored.

Related: GET /customer-sources

get/customers/{customer_id}/customer-source-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.

external_idstring

The external ID of the customer in the external system. Deprecated - use external_ids instead. To filter by external ID within a specific customer source, combine external_ids with the customer_source_id parameter.

customer_source_idstring

The unique ID of the customer source. It identifies the system where the customer belongs or the customer account was created. GET /customer-sources

external_idsstring[]

Filter records by one or more external IDs. Returns records where any stored external ID matches any of the provided values. Use together with customer_source_id to scope the filter to a specific customer source.

To filter by multiple values, use array syntax: external_ids[]=ACSDOIDF23&external_ids[]=BXTE123456

Headers

Accept-Languagestring

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

Response

OK

Example response

{
  "data": {
    "customer_source_records": [
      {
        "customer_source_record_id": "8fd73167342d06899c4c015320",
        "customer_source_id": "86e05affc7a7abefcd513ab400",
        "customer_id": "87af991126405bf8e7dfb36045",
        "external_id": "A66854921C",
        "last_change": "2019-06-23 11:47:22"
      }
    ],
    "total_items": 1
  }
}