APapaleo
CorporateCodes

Returns a list of corporate codes.

Returns all existing corporate codes that match given criteria.<br>You must have this scope: 'rateplans.read-corporate'.<br>For fine-grained clients, you must have this permission: 'core.corporate_codes.read'.

get/rateplan/v1/corporate-codes/codes

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/corporate-codes/codes
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: rateplans.read-corporate, admin

Query parameters

propertyIdstring

Return codes for a specific property

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.

Response

A collection of corporate codes.

countinteger required

Total count of items

Example response

{
  "corporateCodes": [
    {
      "code": "APALEO-NONREF",
      "companyId": "MUC-UMBRELLA",
      "companyCode": "UMBRELLA",
      "companyName": "Umbrella Corp.",
      "ratePlanId": "RP-APALEO-NONREF"
    }
  ],
  "count": 1
}

Changes

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