APapaleo
HurdleRates

Retrieves a paginated list of hurdle rates based on the specified filter criteria.

<br>You must have at least one of these scopes: 'hurdle-rates.read, setup.read'.<br>For fine-grained clients, you must have this permission: 'core.hurdle_rates.read'.

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

Query parameters

propertyIdstring required

The property id

unitGroupIdsstring[] required

The list of unit group identifiers.

fromstring date required

The start date for the specified range.

tostring date required

The end date for the specified range.

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 hurdle rates matching filter criteria.

countinteger required

Total count of items

Example response

{
  "hurdleRates": [
    {
      "propertyId": "P123",
      "unitGroupId": "UG1",
      "date": "2023-10-01",
      "amount": 100,
      "delta": 10,
      "ceiling": 5,
      "maxSolds": 20,
      "upSolds": 2,
      "effectiveAmount": 0,
      "created": "2026-10-09T14:55:37.641922+02:00",
      "updated": "2026-10-09T14:55:37.641922+02:00"
    },
    {
      "propertyId": "P123",
      "unitGroupId": "UG1",
      "date": "2023-10-02",
      "amount": 200,
      "delta": 20,
      "ceiling": 6,
      "maxSolds": 21,
      "upSolds": 3,
      "effectiveAmount": 0,
      "created": "2026-10-09T14:55:37.641922+02:00",
      "updated": "2026-10-09T14:55:37.641922+02:00"
    }
  ],
  "count": 2
}

Changes

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