customers
Search customers with advanced filtering, sorting, and pagination capabilities.
Key Features
- **Multi-criteria Filtering**: Search by customer IDs, debtor IDs, names, email, gender, and date ranges
- **Flexible Sorting**: Sort results by any customer attribute in ascending or descending order
- **Pagination Support**: Control result set size and navigation through large datasets
- **Date Range Filtering**: Filter by creation date or last modification date
Business Rules
- Returns paginated results with metadata about total items found
- Supports partial matching on text fields
- Date filters use inclusive ranges
- Empty search returns all customers (with pagination)
Error Scenarios
- **CUSTOMER_FETCH_ERROR**: System error occurred while searching customer data
- **INVALID_LOOKUP_KEY_ERROR**: Invalid search parameters provided
Use Cases
- Customer management and administration
- Reporting and analytics
- Customer segmentation and targeting
- Data export and integration
AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER]
customers(
input: CustomerSearchArguments
): CustomersResponse!
Arguments
customers.input ● CustomerSearchArguments input
Search criteria and pagination options