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.
includeArchived
string
default:"false"
Set to true to include archived customers in results.
limit
integer
default:"100"
Number of results per page.
offset
integer
default:"0"
Number of results to skip for pagination.

Response Fields

success
boolean
Request status
data
array
Array of customer objects
metadata
object