APapaleo
Company

Get a list of companies

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'.

get/rateplan/v0-nsfw/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/v0-nsfw/companies
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: companies.read, companies.manage, admin

Query parameters

propertyIdstring

Filter by the specified property

ratePlanIdsstring[]

Return companies with any of the specified rate plans

corporateCodesstring[]

Return companies that have any of the requested corporate codes. Use '*' to find companies with any corporate code. Use null (or %00 URL-encoded) to find companies without corporate codes. These can be combined: [null, "CODE1"] returns companies with no codes OR CODE1.

textSearchstring

This will filter all companies for the provided free text. Currently it only looks up if the company name contains one of the provided values

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: identifiers. All other values will be silently ignored.

Response

Success.

countinteger required

Total count of items

Example response

{
  "companies": [
    {
      "identifiers": [
        {
          "scheme": "PEPPOL:0204",
          "value": "991-12345-37"
        }
      ],
      "type": "GovernmentBuyer",
      "id": "MUC-UMBRELLA",
      "code": "UMBRELLA",
      "propertyId": "MUC",
      "name": "Umbrella Corp.",
      "invoicingEmail": "umbrella@corp.com",
      "phone": "+49 89 12345678",
      "taxId": "Tax 123456",
      "additionalTaxId": "123456789",
      "additionalTaxId2": "987654321",
      "invoiceNetworkIdentity": {
        "network": "Peppol",
        "id": "0208:123456789"
      },
      "address": {
        "addressLine1": "Marienplatz 1",
        "postalCode": "80331",
        "city": "München",
        "countryCode": "DE"
      },
      "canCheckOutOnAr": true,
      "ratePlans": [
        {
          "id": "MUC-DBL",
          "code": "DBL",
          "corporateCode": "UMBRELLAINC",
          "name": "Double room flexible"
        }
      ]
    }
  ],
  "count": 0
}

Changes

No recorded changes to this operation across all 4 revisions of this API.