WhiteLabel API
Clients

List Clients

This endpoint (GET) retrieves all your clients. The response is paginated; therefore, you should use the 'page' parameter for navigating through the results in subsequent requests. On successful completion, it returns an array of Client Objects the number of available results and the flags used for filtering. Permissions: clients.view

Query Parameters

page * Fetch the results from a specific page. It defaults to 1.



per_page * The number of results to fetch per page. The maximum is 50 and if it defaults to 10.



from date-format Start date used for filtering.



to date-format End date used for filtering.



countries (Country codes) (example ?countries=de,ro) A list of country codes to use for filtering.



product_id Filter clients by billing plan.



order Determines in which order the results are returned. The available options are asc (ascending) and desc (descending). The default value is desc.