SupDesk
GET/v1/customers

List customers

Lists customers with pagination and optional search by name or email. Use limit to set the maximum number of results and offset to skip results.

3 parameters
limitintegeroptional
Maximum number of customers to return, from 1 to 100. Defaults to 20 when omitted.
Default:20
offsetintegeroptional
Number of customers to skip; must be 0 or greater. Defaults to 0 when omitted.
Default:0
qstringoptional
Search customers by name or email.

2 status codes
200Returns a paginated list of customers in `data`, with pagination metadata including the limit, offset, and whether more results are available.
dataarray<object>optional
paginationobjectoptional
401Returned when the request is unauthenticated or authentication is invalid.
errorobjectoptional

Error handling

A 401 is returned when the request lacks valid authentication. limit must be between 1 and 100, and offset must be 0 or greater.