API Reference
HELP CENTERINTEGRATIONSSTATUS PAGELOGINGET STARTED FREE

List customers

get
https://api.sandbox.cleeng.com/3.1/customers

This endpoint returns customers that match the requirements given in the API request. For example, it allows you to filter customers based on externalId or email.

Note: One of the parameters: either externalId or email is required.

The recommended limit for checking if a user is registered using an email address is: 1.

Query Params
int32
required

From which element you want to get results. Helpful in pagination.

int32
required

Number of results you want to retrieve. E.g. if you want to display 10 customers per page, and you are on the third, just set the limit to 10 and offset to 20.

string

Set an external ID of a customer to return only customers with this external ID. Required if email is not provided.

string

Set an email address of the user, to get detailed information about the user's account. Required if externalId is not provided.

Headers
string
Defaults to application/json
Responses

Updated 9 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 months ago