List Customers

get

https://api.ewitypos.com/apps-v1/customers

Paginated list of the store's customers, newest first by default. Requires the p/r-customer permission. The response carries a search object describing the filters available on this listing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

Defaults to 1

Page number.

limit

integer

Defaults to 20

Items per page.

no_paginate

boolean

When truthy, returns all matching rows in data with no pagination object.

order_by

string

Sort field, optionally with a direction: field:asc or field:desc. A bare field name sorts descending. Supported fields: id (default), name, total_outstanding, total_spent, loyalty_points, created_at.

show_addresses

boolean

When truthy, each customer includes its addresses array.

q_q

string

Free-text search. Numeric values match the mobile number, other values the name; email and note always match too (and passport, when the company's passport-scanning setting is enabled).

q_birth_day

string

Birthday range filter as YYYY-MM-DD,YYYY-MM-DD. Matches by day-of-year — the year part is ignored, so 2026-01-19,2026-01-21 matches a customer born 1988-01-20.

q_created_at

string

Created-at date range filter as YYYY-MM-DD,YYYY-MM-DD (inclusive, whole days).

Headers

X-Ewity-Store

string

required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated customer list.