# List the customers (deprecated) API Reference Returns a paginated list of customers, with optional filters. - **Deprecated:** use `GET /v1/companies/{company_id}/customers`, which behaves identically. **Retires on 9 December 2026.** See the [migration guide](https://docs.beel.es/changelog/resources-under-the-nif) for what moved where and what changes when you switch. ## GET /v1/customers **List the customers** Returns a paginated list of customers, with optional filters. - **Deprecated:** use `GET /v1/companies/{company_id}/customers`, which behaves identically. **Retires on 9 December 2026.** See the [migration guide](https://docs.beel.es/changelog/resources-under-the-nif) for what moved where and what changes when you switch. **Deprecated.** ### Authentication Accepts any of: - `ApiKeyAuth` (HTTP bearer, token format `beel_sk_*`) ### Parameters - **page** (optional) in query `integer` (default: 1): Page number, starting at 1. The response echoes it back as `pagination.current_page`. - **limit** (optional) in query `integer` (default: 20): How many items to return per page. The response echoes it back as `pagination.items_per_page`. - **active** (optional) in query `boolean`: 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** (optional) in query `string`: Global search by name, NIF or email - **legal_name** (optional) in query `string`: Filter by legal name (partial search case-insensitive) - **nif** (optional) in query `string`: Filter by NIF (partial search) - **email** (optional) in query `string`: Filter by email (partial search) - **phone** (optional) in query `string`: Filter by phone (partial search) - **city** (optional) in query `string`: Filter by city - **province** (optional) in query `string`: Filter by province - **sort_by** (optional) in query (default: "legal_name"): 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. - **sort_order** (optional) in query (default: "asc"): Sort order direction ### Responses #### 200: Customer list retrieved successfully **Content `application/json`:** - **success** (required) `boolean`: No description (example: true) - **data** (required): The payload. An object for a single resource; an object holding the named collection (and its `pagination`) for a listing. Never a bare array at this level in v1. - **meta** `ResponseMeta` - **data** `object`: No description - **customers** (required) `array[Customer]`: No description - **pagination** (required) `Pagination` **Example `list_success`** — List customers (200): ```json { "success": true, "data": { "customers": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "legal_name": "Tech Solutions SL", "nif": "B12345674", "email": "admin@techsolutions.com", "phone": "+34912345678", "address": { "street": "Calle Mayor", "number": "15", "postal_code": "28013", "city": "Madrid", "province": "Madrid", "country": "España" }, "active": true, "created_at": "2024-06-15T10:30:00Z", "updated_at": "2025-01-10T14:00:00Z" }, { "id": "789abc12-34de-56f7-8901-234567890abc", "legal_name": "María García López", "nif": "12345678Z", "email": "maria.garcia@email.com", "phone": "+34654321987", "address": { "street": "Avenida de la Constitución", "number": "25", "floor": "3º", "door": "B", "postal_code": "41001", "city": "Sevilla", "province": "Sevilla", "country": "España" }, "active": true, "created_at": "2024-08-20T09:00:00Z", "updated_at": "2024-12-01T11:30:00Z" }, { "id": "456def78-90ab-12cd-3456-78ef01234567", "legal_name": "Distribuidora Levante SA", "nif": "A22222222", "email": "contabilidad@distribuidoralevante.es", "phone": "+34963456789", "address": { "street": "Polígono Industrial Norte", "number": "7", "postal_code": "46007", "city": "Valencia", "province": "Valencia", "country": "España" }, "active": false, "created_at": "2024-03-10T16:45:00Z", "updated_at": "2024-11-20T08:00:00Z" } ], "pagination": { "current_page": 1, "items_per_page": 20, "total_items": 3, "total_pages": 1, "has_next": false, "has_previous": false } }, "meta": { "timestamp": "2025-01-20T12:00:00Z", "request_id": "550e8400-e29b-41d4-a716-446655440000" } } ``` #### 400: The request target could not be read as declared, so nothing was looked up. Three causes, all named in `error.details`: a path or query parameter whose value does not parse as its type (`VALIDATION_ERROR` — a UUID that is not a UUID, an unknown enum value, an empty element in a list such as `status=ISSUED,`), a required parameter that was not sent (`MISSING_PARAMETER`), or a header that is meant to carry an identifier and does not (`ACTIVE_COMPANY_HEADER_INVALID`). A list parameter sent entirely empty (`status=`) is not an error: it is the same as omitting it. The fault is in the target, not in the content — which is what `422` is defined over. **Content `application/json`:** - **success** (required) `boolean`: No description (example: false) - **error** (required) `ErrorDetail` - **meta** `ResponseMeta` - **type** `string` (uri): Stable URI that identifies the problem type and where the integrator will find its documentation. (example: "https://docs.beel.es/errors/INVOICE_NO_LINES") - **title** `string`: Short summary of the problem type. Stable between occurrences of the same `type`. (example: "INVOICE_NO_LINES") - **detail** `string`: Specific message for this occurrence, localized according to `Accept-Language` (`es`, `en`, `ca`); defaults to English. Matches the legacy `error.message`. (example: "The invoice must have at least one line") - **instance** `string` (uri-reference): URI that identifies the specific occurrence of the problem — typically the path of the affected resource. (example: "/v1/invoices/abc-123") **Example:** ```json { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "The parameter 'invoice_id' has an invalid type. Expected: UUID.", "details": { "field": "invoice_id", "invalid_value": "deliveries", "expected_format": "UUID" } }, "meta": { "timestamp": "2025-01-15T10:30:00Z", "request_id": "4bf92f3577b34da6a3ce929d0e0e4736" } } ``` #### 401: Missing or invalid authentication. Like every other error, `message`/`detail` is localized according to `Accept-Language` (`es`, `en`, `ca`); defaults to English when the header is missing or asks for none of those. **Content `application/json`:** - **success** (required) `boolean`: No description (example: false) - **error** (required) `ErrorDetail` - **meta** `ResponseMeta` - **type** `string` (uri): Stable URI that identifies the problem type and where the integrator will find its documentation. (example: "https://docs.beel.es/errors/INVOICE_NO_LINES") - **title** `string`: Short summary of the problem type. Stable between occurrences of the same `type`. (example: "INVOICE_NO_LINES") - **detail** `string`: Specific message for this occurrence, localized according to `Accept-Language` (`es`, `en`, `ca`); defaults to English. Matches the legacy `error.message`. (example: "The invoice must have at least one line") - **instance** `string` (uri-reference): URI that identifies the specific occurrence of the problem — typically the path of the affected resource. (example: "/v1/invoices/abc-123") **Example:** ```json { "success": false, "error": { "code": "UNAUTHORIZED", "message": "Authentication is required to access this resource" }, "meta": { "timestamp": "2025-01-15T10:30:00Z", "request_id": "4bf92f3577b34da6a3ce929d0e0e4736" } } ``` #### 403: Authenticated but not allowed. Fourteen causes shared by every operation, told apart by `error.code`; an operation that adds a cause of its own names it in its `403`. You can branch on them exhaustively. - `INSUFFICIENT_SCOPE` — the credential lacks a scope the operation requires; `error.details.missing_scopes` names them as a single comma-separated string (for example `"invoices:write,customers:read"`), not as an array; `required_scopes` has the same shape and lists every scope the operation needs. Retrying will not help: mint a key that holds them. - `COMPANY_READ_ONLY` — the scope is there, but your access level over that NIF only lets you read it. - `ACCOUNT_MANAGEMENT_FORBIDDEN` — the scope is there, but your role over the account, or the management relationship you hold over it, does not cover this operation. - `ACCOUNT_NOT_ACCESSIBLE` — the account is not yours to reach, which is also the answer when it does not exist, so existence is never disclosed. - `ACTIVE_COMPANY_NOT_ACCESSIBLE` — the same, for a NIF: the company in the path, or the one named by `BeeL-Active-Company`, is not one this credential may reach — and again, this is also the answer when it does not exist. - `COMPANY_ACCESS_REVOKED` — your access to the NIF was withdrawn while the request was already in flight, so the write was rejected and nothing was recorded. Retrying will not help until the access is granted again. - `LIVE_CREDENTIAL_REQUIRED` — the operation changes the real account and the call came from a test API key (`beel_sk_test_…`). Use your live key or the dashboard. - `FEATURE_NOT_AVAILABLE` — your subscription does not include the entitlement the operation needs; `error.details.feature_code` names it. This gate runs **before** the scope gate, so for such an operation you never see `INSUFFICIENT_SCOPE` first. - `NO_ACTIVE_ACCOUNT` — the credential does not resolve to an account, so no scope can be evaluated against one. Fail-closed, not a permission that can be granted to you. - `OPERATION_REQUIRES_SESSION` — the operation is available only from the web session; no API key and no OAuth2 token can perform it, whatever scopes it holds. - `OPERATION_REQUIRES_API_KEY` — the reverse: the operation needs a scope that only an API key can hold (such as `accounts:write`), so a dashboard session never satisfies it. - `API_KEY_LIVE_NOT_AVAILABLE` — the call came with a live API key (`beel_sk_live_…`) and the account has no Live mode yet. It is never degraded to Test: use your test key, or activate Live first. - `ACCOUNT_REQUIRES_FOCUS_SWITCH` — dashboard session only: you are a member of the account in the path, but it is not the account in focus. Switch focus to it and retry. - `REQUEST_BLOCKED` — the edge security filter stopped the request before the API saw its body, usually because a text field carries something that looks like markup or a script (HTML tags, `