beel_list_companies
Retrieve paginated companies (NIFs) for an account, filter by NIF or legal/trade name, and optionally include issuing-readiness status.
Instructions
Returns a page of the companies (NIFs) belonging to the account in the path, ordered with
the primary company first. search filters case-insensitively on NIF, legal name and
trade name; include=readiness adds each company's issuing-readiness block. The response
is always paginated, and an account with no companies yet returns an empty page rather
than an error.
The invoice series of each company are not part of this response: read them from
GET /v1/companies/{company_id}/series.
Endpoint: GET /v1/accounts/{account_id}/companies
⚠️ Fiscal guardrails — read before calling:
Which company an operation acts on, and how that is selected. (resource: beel://guardrails/multi-nif)
For the exhaustive rules and worked examples, call beel_docs_search.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. The response echoes it back as `pagination.current_page`. | |
| limit | No | How many items to return per page. The response echoes it back as `pagination.items_per_page`. | |
| search | No | Case-insensitive filter on NIF, legal name or trade name. Blank/omitted returns all. | |
| include | No | Include derived data. `readiness` adds each company's issuing-readiness status. | |
| account_id | Yes | Your own account, or an account you provisioned. It — not the credential — decides which account the operation acts on; a `403` is returned when you do not reach it, the same response an account that does not exist gets. |