---
title: "Get a list of companies"
method: GET
path: "/rateplan/v1/companies"
tags: ["Company"]
---

# Get a list of companies

`GET /rateplan/v1/companies`

## Request

- Base URL: `https://api.apaleo.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.apaleo.com/rateplan/v1/companies`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `companies.read`, `companies.manage`, `admin`

Get the list of companies.
<br>You must have at least one of these scopes: 'companies.read, companies.manage'.<br>For fine-grained clients, you must have this permission: 'core.companies.read'.

## Query parameters

- `propertyId` string
- `ratePlanIds` string[]
- `corporateCodes` string[]
- `textSearch` string
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Success.

- CompanyListModel
  - `companies` CompanyModel[], required: List of companies
    - `id` string, required: The ID of this company
    - `code` string, required: The code for the company
    - `propertyId` string, required: The ID of the property
    - `name` string, required: The name of the company
    - `invoicingEmail` string, nullable: The email address for invoicing purposes
    - `phone` string, nullable: The company's phone number
    - `taxId` string, nullable: The tax ID of the company
    - `additionalTaxId` string, nullable: The additional tax ID of the company (e.g. SIRET in France, Codice Destinatario in Italy, SST in Malaysia)
    - `additionalTaxId2` string, nullable: The additional tax ID of the company (e.g. Codice Fiscale in Italy, BRN in Malaysia)
    - `invoiceNetworkIdentity` InvoiceNetworkIdentityModel
      - `network` 'Peppol', required: The Network through which to send the Invoice e. g. Peppol
      - `id` string, required: The Id of the company at the network. e.g. "0208:123456789"
    - `address` CompanyAddressModel, required
      - `addressLine1` string, required
      - `addressLine2` string, nullable
      - `postalCode` string, required
      - `city` string, required
      - `regionCode` string, nullable
      - `countryCode` string, required
    - `canCheckOutOnAr` boolean, required: Whether or not the company is allowed to check out on AR / invoice
    - `ratePlans` RatePlanCompanyModel[], nullable: Rate plans that can be booked by this company
      - `id` string, required: Rate plan ID that is used by this company
      - `code` string, required: Rate plan code that is used by this company
      - `corporateCode` string, nullable: Company rate plan code, identifying the company + rate plan pair. Is used is offers.
      - `name` string, required: The name of the rate plan
  - `count` integer, required: Total count of items

## Other responses

- `204`: Could not find any companies.
- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api/revisions/9c4f5fec8ed5?raw)