Skip to main content
GET
Returns a paginated list of customers belonging to the authenticated instance. By default, archived customers are excluded.

Query Parameters

Free-text search across customer fields.
string
default:"false"
Set to true to include archived customers in results.
integer
default:"100"
Number of results per page.
integer
default:"0"
Number of results to skip for pagination.

Response Fields

boolean
Request status
array
Array of customer objects
object