Customers & catalog · Clients
List clients
Returns your clients, newest first, one page at a time. Deleted clients are left out.
The clients are in data.data and the paging details in data.pagination. totalPayment is what the client has paid you, in US dollars. To get one client with its totals, use Get client.
Authorization
HeaderSend Authorization: Bearer <accessToken>, the token from Create token.
Query parameters
search string
Case-insensitive match on the client's name, email or company.startsWith string
Clients whose name starts with this text (case-insensitive), e.g. A.status enum
ACTIVE, INACTIVE, DRAFT or PENDING.country string[]
Exact match on the client's country as stored. Repeat the parameter for several (country=US&country=GB); in this form, separate them with commas.tag string[]
Clients with this tag (its name or slug). Repeat the parameter for several; in this form, separate them with commas.hasActiveProject enum
yes: clients with an open or in-progress project. no: clients without one.sortBy enum
name, email, createdAt (default) or updatedAt. lastInteraction sorts like updatedAt; totalEarnings and deletedAt are accepted but keep the default order.order enum
asc or desc (default).page integer
Page number, starting at 1 (default 1).limit integer
Clients per page (default 10).