This call is deprecated. We recommend to use CRM API instead.

The corresponding new call is: GET /v1/customers/external-ids.

Get all customer to external ID pairs for provided integration name.

New external ID can be updated or added to customer using saveCustomerExternalId call.

External ID can be removed from customer using removeCustomerExternalId call.

Customer ID can be retrieved by external ID using getCustomerIdByExternalId call.

All external IDs for exact customer can be retrieved using getExternalIdsByCustomerId call.

Input parameters

Parameter name Description Possible value Required
integrationName String yes
recordsOnPage Number of records API should return. By default 20, at most 100. Integer
pageNo API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". Integer


Field name Type Description
integrationName String
customerID Integer
externalID String