List Customers
Retrieve a paginated list of all customers for the authenticated team.
Search Functionality:
The search parameter performs partial, case-insensitive matching across:
- Customer name
- Email address
- Main phone number
Pagination:
- Results are paginated with configurable page size
- Maximum 100 records per page to prevent performance issues
- Response includes total record count for pagination calculation
Sorting:
- Default sort: Customer name (ascending)
- Available sort fields: customer, email, createdAt, updatedAt
- Sort direction: ASC or DESC
Edge Cases:
- If
pageexceedstotalPages, returns emptyrecordsarray - If
searchhas no matches, returns emptyrecordsarray with totalRecords: 0 - If team has no customers, returns empty
recordsarray
Use Cases:
- Display customer list in your application
- Search for specific customers
- Export customer data
- Sync customers to external systems
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
What made this section unhelpful for you?
Response
What made this section unhelpful for you?