list_customers
Retrieve a list of customers with optional filtering by status, search term, sorting, and pagination. Include related data like subscriptions, invoices, and payment methods.
Instructions
List customers with optional query parameters for filtering and pagination. GET /customers. See https://apiguide.rebillia.com/ for the Public API.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pageNo | No | Page number (default: 1) | |
| itemPerPage | No | Items per page (default: 25, max 250) | |
| query | No | Search term: matches firstName, lastName, email, and related company name/support pin | |
| status | No | Filter by customer status: active, disabled, or archived | |
| sortBy | No | Sort direction: ASC or DESC (default: ASC for customers) | |
| orderBy | No | Column to sort by (e.g. firstName, lastName, email, createdAt). Default: firstName | |
| include | No | Comma-separated includes: addressbook, paymentmethod, lastInvoice, subscriptions, unpaidInvoices, externalCustomers | |
| filterId | No | Optional saved filter ID to apply predefined filters |