Get customer source records
Get all customer source records.
Customer source records link customer accounts to the external systems that created or track them. Each record includes the source ID and one or more external IDs from that system. This endpoint returns source records across all customers. To retrieve source records for a specific customer, use GET /customers/{customer_id}/sources.
When both the external_ids and external_id filter parameters are provided, external_ids takes priority and external_id is ignored.
Query parameters
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.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
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.
Direction of sorting the response list.
The unique ID of the customer. GET /customers
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.
The unique ID of the customer source. It identifies the system where the customer belongs or the customer account was created. GET /customer-sources
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
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
}
}