API Reference

List customers

get
https://api.ecommerceapi.uk/v1/customers

Retrieves a list of customers with pagination and filtering options.

Query Params
integer
≤ 100
Defaults to 50

Number of records to retrieve (default: 50, max: 100).

integer
Defaults to 0

Number of records to skip.

string
enum

Sorting order for the results. Defaults to creation date.

Allowed:
integer
enum

0 for regular customers, 1 for trade customers.

Allowed:
string

Comma-separated list of properties to include in the response.

string

Search customer records by email address.

string

Comma-separated list of properties to embed. Available options: country,state,wishlists,custom_fields.

Responses

400

Invalid request parameters.

401

Unauthorized. Invalid or missing API key.

500

Server error.

Updated over 1 year ago

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

Updated over 1 year ago

Did this page help you?