GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussions API Change LogOpenAPI Specification Download
API Endpoints
Home
  1. Public API
  2. Retail Experience Cloud Bridge

Get External Customers

get
https://api.talkdeskapp.com/erc/ecommerce/external/customers

Read the external customers.

A successful request returns the list of external customers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

erc-ecommerce-customers:read

Query Params
integer
1 to 99999
Defaults to 1

Desired page. Defaults to 1.

integer
1 to 100
Defaults to 10

Limit the number of customers per page. Defaults to 10.

string
length between 1 and 255

The external customer name

string
length between 1 and 255

The external customer phone

string
length between 1 and 255

The external customer email

string
length between 1 and 50

The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.

string
enum
Defaults to exact

The match mode for customer search. Defaults to "exact". Valid values: "exact", "fuzzy".

Allowed:
ids
array of strings

The external customer ids

ids
Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?