HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

List customers

get deprecated
https://{domain_prefix}.retail.lightspeed.app/api/customers

DEPRECATED This endpoint has a 2.0 equivalent. We recommend using that instead.

Returns a paginated list of customers.

🔒 Requires: customers:read scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

If included, searches for customers with the given unique ID. The id option cannot be used with the code or email options.

string

If included, searches for customers with the given customer code. The code option cannot be used with id or email options.

string

If included, searches for customers with the given email address. This is an exact match search. The email option cannot be used with the id or code options.

date-time

If included, returns only items modified since the given time. The provided date and time should be in UTC and formatted according to ISO 8601.

number

The number of the page of results to be returned.

number

The size of the page of results to be returned.

Response

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?