# List Clients Returns a paginated list of the clients in the account. Archived clients are included unless status says otherwise. Endpoint: GET /api/v3/clients Version: 3.1.0 Security: apiKeyAuth ## Query parameters: - `api_key` (string, required) Your API Key. Example: "YOUR_API_KEY" - `status` (string) active returns only clients that are not archived, archived only archived ones, all both. Any other value is treated as all. Applies to the rows, the search and the pagination counts. Enum: "all", "active", "archived" - `page` (integer) Page number (default 1). Example: 1 - `per_page` (integer) Results per page (default 10). items_per_page and page_items are accepted as aliases. Example: 10 - `term` (string) Search text. Matches clients whose name, fiscal_id, email or code contains it. Example: "Acme" - `sort` (string) Field to sort by (default name). Any other value falls back to name. Enum: "name", "fiscal_id", "email", "code", "created_at", "balance" - `sort_order` (string) Sort direction (default ASC, case-insensitive). Any other value falls back to ASC. Enum: "ASC", "DESC" ## Response 200 fields (application/json): - `clients` (array) - `clients.id` (integer) Example: 191880320 - `clients.name` (string) Example: "John Doe" - `clients.fiscal_id` (string,null) Maximum length is the database default, not an enforced business rule. Example: "508025338" - `clients.email` (string,null) Example: "john@example.com" - `clients.balance` (string,null) Latest client balance, as a decimal string. null when the client has no balance record yet. Example: "2774.38" - `clients.created_at` (string) Example: "2025-01-23T10:22:33+00:00" - `clients.code` (string) ISO code of the account's currency (the same for every client in the list). This is not the client's own code. Example: "EUR" - `clients.archived_at` (string,null) When the client was archived, or null when it is not archived. List rows carry only this field; archived and can_be_deleted are returned by show, create and update. - `pagination` (object) - `pagination.total_entries` (integer) Example: 18 - `pagination.current_page` (integer) Example: 1 - `pagination.total_pages` (integer) Example: 2 - `pagination.per_page` (integer) Example: 10 ## Response 401 fields (application/json): - `errors` (array) Example: [{"error":"Authentication Error"}] - `errors.error` (string)