PEperk

List all Companies

Changed on

List all companies associated to this account

get/companies

Request

  • Base URL
    https://api.travelperk.com
  • URL
    https://api.travelperk.com/companies
  • Auth
    API key in header Authorization

Query parameters

offsetinteger

[optional] Pagination offset index, 0 based (page number). Defaults to 0.

limitinteger

[optional] Maximum number of elements to return per page. Allowed values are in the range [1, 50]. See more info in Pagination. Defaults to 10.

include_disabledboolean

[optional] Controls whether to include disabled companies in the results. The account's default company is always included regardless of this setting. Defaults to false.

Response

200

offsetinteger
limitinteger
totalinteger

Example response

{
  "limit": 10,
  "total": 2,
  "companies": [
    {
      "name": "My Company Ltd",
      "tax_id": "instant"
    }
  ]
}

Changes