APapaleo
Rate

Returns a list of rates.

Returns all rates for a specific rate plan within the specified time range. If a rate has not been initialized, it will still be returned, but anything besides the from and to values will be empty. The time range of a rate is defined by the time slice definition of the rate plan.

Time ranges with no initialized rates will not be available for sell.

To be able to read rates for a corporate rate plan a client must additionally have the 'rateplans.read-corporate' scope.<br>You must have at least one of these scopes: 'rates.read, rates.manage'.<br>For fine-grained clients, you must have this permission: 'core.rates.read'.

get/rateplan/v0-nsfw/rate-plans/{id}/rates

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/rate-plans/{id}/rates
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: rates.read, rates.manage, admin

Path parameters

idstring required

The id of the rate plan.

Query parameters

fromstring required

The start of the time range to filter the rates by. All rates where the from date and time is equal or later than the specified date and optional time will be affected<br />Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring required

The end of the time range to filter the rates by. All rates where the from date and time is earlier than the specified date and optional time will be affected<br />Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

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

Return all rates for a rate plan.

countinteger required

Total count of items

Example response

{
  "rates": [
    {
      "from": "2026-10-09T17:00:00+02:00",
      "to": "2026-10-10T11:00:00+02:00",
      "price": {
        "amount": 123,
        "currency": "EUR"
      },
      "calculatedPrices": [
        {
          "adults": 2,
          "price": {
            "amount": 133,
            "currency": "EUR"
          }
        }
      ],
      "restrictions": {
        "minLengthOfStay": 2,
        "maxLengthOfStay": 30,
        "closed": false,
        "closedOnArrival": true,
        "closedOnDeparture": true
      }
    }
  ],
  "count": 0
}

Changes

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