List Customers
Header Parameters
Query Parameters
Search term to filter customers. Searches across customer name, email, and mainPhone using partial matching (case-insensitive).
Example: "acme" will match "Acme Corp" and "acme@example.com"
Page number for pagination. First page is 1.
If page exceeds total pages, returns empty results.
Number of records to return per page. Maximum 100 to prevent performance issues.
Field to sort results by
customeremailcreatedAtupdatedAtSort direction. ASC = ascending, DESC = descending
ASCDESCResponse
Response Attributes
Always "success" for successful requests
Human-readable success message
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
Response