AccountCompanies

List the companies of an account

Returns the companies (NIFs) belonging to the account in the path, ordered with the primary company first. An account with no companies yet returns an empty list rather than an error.

  • search: filters case-insensitively on NIF, legal name and trade name.
  • include=readiness: adds each company's issuing-readiness block.
  • Paginated, always: without page and limit you get the first 20 companies, not all of them, and pagination is present in every response — a single-company account simply gets a one-item page.
  • Series: not part of this response. Read them from GET /v1/companies/{company_id}/series.
get/v1/accounts/{account_id}/companies

Request

  • Base URL: https://app.beel.es/api
  • URL: https://app.beel.es/api/v1/accounts/{account_id}/companies
  • Auth: one of:
    • HTTP bearer
    • API key in cookie BEEL_SESSION

Query parameters

pageinteger

Page number, starting at 1. The response echoes it back as pagination.current_page.

limitinteger

How many items to return per page. The response echoes it back as pagination.items_per_page.

searchstring

Case-insensitive filter on NIF, legal name or trade name. Blank/omitted returns all.

include'readiness'

Derived data to expand on each company of the list.

Example:readiness

Include derived data. readiness adds each company's issuing-readiness status.

Response

List of companies

successboolean

Example response

{
  "data": {
    "companies": [
      {
        "entity_type": "INDIVIDUAL",
        "environment": "PROD",
        "aeat_environment": "PROD",
        "account_state": "TEST_ONLY",
        "legal_representative": {
          "full_name": "María García López",
          "nif": "12345678A",
          "address": {
            "street": "Calle Mayor, 123",
            "number": "123",
            "floor": "2º A",
            "door": "A",
            "postal_code": "28001",
            "city": "Madrid",
            "province": "Madrid",
            "country": "España",
            "country_code": "ES"
          }
        },
        "phone": "+34 612 345 678",
        "email": "user@example.com",
        "default_iban": "ES1234567890123456789012",
        "default_swift": "ABCDESMMXXX",
        "invoice_template_type": "MODERN_TABLE",
        "invoice_accent_color": "#fc481d",
        "invoice_language": "es",
        "email_language": "es"
      }
    ],
    "pagination": {
      "current_page": 1,
      "total_pages": 5,
      "total_items": 87,
      "items_per_page": 20
    }
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.