Core Resources · Clients

Get All Clients

Retrieve a list of clients with support for searching, sorting, and status filtering.

Header

Query Params

id string

Filter by client ID.

search string

Search by name, company, or email (e.g., "john").

startsWith string

Filter clients whose names start with the specified string.

sortBy string

Sort by name, email, totalEarnings, lastInteraction, or createdAt.

order string

(Optional) Sort order (asc or desc).

limit string

(Optional) Number of results to return.

page string

(Optional) Page number for pagination (default is 1).

status enum

Initial status: ACTIVE, INACTIVE, DRAFT, or PENDING.