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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

erc-ecommerce-customers:read

Query Params

page

integer

1 to 99999

Defaults to 1

Desired page. Defaults to 1.

per_page

integer

1 to 100

Defaults to 10

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

name

string

length between 1 and 255

The external customer name

phone

string

length between 1 and 255

The external customer phone

string

length between 1 and 255

The external customer email

brand

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.

matchMode

string

enum

Defaults to exact

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

Allowed:

address_phone

string

length between 7 and 255

^[+0-9][0-9\s\-().]*$

A fallback phone number to search against customer address records in the local database. When provided and the primary Callbar search returns no results, the system performs an additional lookup by matching this value against the phone numbers stored in the customer's address records. Must contain at least 7 digits; may include formatting characters such as +, spaces, dashes, and parentheses.

ids

array of strings

The external customer ids

ids

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

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

application/json

Scope

200The customer external customers with the provided parameters.

400Bad Request

401Unauthorized

403Forbidden

404Not found

405Method not supported

500Internal Server Error

502Bad Gateway