v1
latestOpenAPI 3.1.02026-07-241080412.6 KBList 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.<br><br>The recommended limit for checking if a user is registered using an email address is: 1.
get/customers
Query parameters
offsetinteger required
From which element you want to get results. Helpful in pagination.
limitinteger 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.
externalIdstring
Set an external ID of a customer to return only customers with this external ID. Required if email is not provided.
emailstring
Set an email address of the user, to get detailed information about the user's account. Required if externalId is not provided.
Headers
Content-Typestring
Response
200
Example response
{
"success": true,
"data": [
{
"id": 420980622,
"email": "email@domain.com",
"country": "AT",
"regDate": "2020-01-13 10:21:35",
"lastLoginDate": "2020-01-13 10:21:35",
"lastUserIp": "213.156.120.102",
"currency": "AUD",
"locale": "en_US",
"externalId": "jdh545dh345",
"externalData": {
"data": "data"
}
}
],
"message": "Customers list fetched successfully"
}