API Reference

Get customer source records

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/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 Params
integer
≥ 1
Defaults to 100

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.

integer
≥ 0
Defaults to 0

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

string

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.

string
enum

Direction of sorting the response list.

Allowed:
string

The unique ID of the customer.

string
deprecated

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.

string

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

external_ids
array of strings

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

external_ids
Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 5 days ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 days ago