beel_list_customers
Fetch a paginated customer list for a company NIF, apply filters like name, email, city, or status, and sort results by selected fields.
Instructions
Returns a paginated list of the customers of this company (NIF), with optional filters. Only the customers of the company in the path are returned.
Endpoint: GET /v1/companies/{company_id}/customers
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| nif | No | Filter by NIF (partial search) | |
| city | No | Filter by city | |
| page | No | Page number, starting at 1. The response echoes it back as `pagination.current_page`. | |
| No | Filter by email (partial search) | ||
| limit | No | How many items to return per page. The response echoes it back as `pagination.items_per_page`. | |
| phone | No | Filter by phone (partial search) | |
| active | No | Filter by active/inactive status. Defaults to `true`, so inactive customers must be requested explicitly with `active=false`. Deleted customers are never returned by either value. | |
| search | No | Global search by name, NIF or email | |
| sort_by | No | Field to sort by. Results are always tie-broken by a stable internal key, so paging through the collection never repeats or skips a customer. | legal_name |
| province | No | Filter by province | |
| company_id | Yes | NIF (company) the operation acts on. It is the only source of context: the account that owns it is derived from it, and the `BeeL-Active-Company` header plays no part. A NIF you do not reach answers `403`, and so does a NIF that does not exist, so the existence of a NIF in another account is never disclosed. | |
| legal_name | No | Filter by legal name (partial search case-insensitive) | |
| sort_order | No | Sort order direction | asc |