Search customers with advanced filtering
POST/v2/customers/search
Performs advanced customer search with multiple filtering criteria, sorting options, and pagination. Supports complex queries across customer attributes, contact information, and metadata.
Search Capabilities:
- Multi-field filtering (name, email, phone, dates, etc.)
- Flexible date range searches
- Multiple value matching (OR logic within fields)
- Custom sorting by any customer field
- Pagination with configurable page sizes
- Source system filtering
Performance Features:
- Optimized database queries with proper indexing
- Configurable result limits to prevent large responses
- Efficient pagination for large datasets
- Cached results for frequently accessed data
Use Cases:
- Customer discovery and segmentation
- Data analysis and reporting
- Integration with external systems
- Customer service lookup tools
- Marketing campaign targeting
Request
Responses
- 200
- 400
- 401
- 403
Search completed successfully with paginated results
Invalid search criteria or validation errors
Authentication required - provide valid OAuth2 token
Insufficient permissions - requires customers:read scope