v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Customer sources

Get customer sources

Get information about all customer account sources.

Customer sources identify the external systems or applications where customer accounts originate or are tracked - for example, a mobile application, e-commerce platform, POS system, or web portal. Each customer account is assigned to at least one source, and the source record can carry one or more external IDs from that system.

Related: GET /customers/{customer_id}/sources

get/customer-sources

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.

customer_source_text_idstring

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

Headers

Accept-Languagestring

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

Response

OK

Example response

{
  "data": {
    "customer_sources": [
      {
        "customer_source_id": "86e05affc7a7abefcd513ab400",
        "name": "Webshop registration",
        "customer_source_text_id": "webshop_registration",
        "state": 1,
        "last_change": "2019-01-08 18:34:07"
      }
    ],
    "total_items": 1
  }
}