Get customer source records

get

https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers/{customer_id}/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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customer_id

string

required

The unique ID of the customer.

Query Params

count

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.

offset

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.

sort_field

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.

sort_direction

string

enum

Direction of sorting the response list.

Allowed:

external_id

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.

customer_source_id

string

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_ids

array of strings

length ≤ 1000

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

Accept-Language

string

Defaults to cs, en-gb;q=0.8

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

Responses

`error.error_data.invalid_params[]` array lists the parameters that caused the failure, each carrying a `reason` code. See the `BadRequestErrorBody` schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

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.

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access an unauthorized property or resource.

404The request path does not match any API route, or the addressed resource does not exist.

405The request path matches a valid route, but the endpoint does not support the HTTP method used in the request.

500Server is not working as expected.