Qodex.ai

Get all customers

GET https://api.ecartapi.com/api/v2/customers

Returns a list of Customers. Optional filter parameters can be passed in.

More information about the ecommerce's resource.

Request Params

KeyDatatypeRequiredDescription
limitstringDefault value: 50. The maximum number of documents returned in the response
idsstringFilter by the required identifier.
createdAt[from]stringFilter orders by range. Requires createdAt[to]. Set the lower treshold.
createdAt[to]stringFilter orders by range. Requires createdAt[from]. Set the upper treshold.
updatedAt[from]stringFilter orders by range. Requires updatedAt[to]. Set the lower treshold.
updatedAt[to]stringFilter orders by range. Requires updatedAt[from]. Set the upper treshold.
emailstringFilter results by email.
namestringFilter results by name.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"success":true,"customers":[{"id":"1","email":"fake@email.com","firstName":"Jane","lastName":"Doe","status":{"id":null,"status":null},"note":null,"phone":"8111111111","currency":null,"addresses":[],"dates":{"createdAt":"2021-12-10T21:29:36Z","updatedAt":"2021-12-10T21:29:36Z"}}]}