List clients
GET/v1/clients
Returns a paginated list of your company clients. Filter by name, phone, source, points and more; sort and page through results.
Required scope: clients:read
Request
Responses
- 200
- 401
- 403
- 404
- 422
A page of clients.
Unauthenticated — the request is missing a credential, or the Bearer token / API key is invalid, expired, or revoked.
Insufficient scope — the credential is authenticated but lacks a scope the endpoint requires.
Not found — no resource matches the id in the path (or it belongs to a different company).
Validation failed — the request body failed schema validation. errors[] lists every offending field.