API Reference

Get list of customers

get
https://example.com/customers/private/v1/customers

Returns the list of customers

Query Params
integer
Defaults to 1

The page of results.

integer
Defaults to 1

The numbers of items to return.

string
Defaults to created_at

Sort the result-set in ascending or descending(use "-") order..

string

For filtering by query (email, first_name, last_name, phone_number)

string

For filtering by status (pending, active, blocked, dormant)

string

For filtering by role name (buyer, supplier, financier)

integer

For filtering by group

string

YYYY-MM-DD

string

YYYY-MM-DD

integer

For filtering by class id

Responses

Updated 7 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago