---
title: "Retrieves a paginated list of hurdle rates based on the specified filter criteria."
method: GET
path: "/rateplan/v0-nsfw/hurdle-rates"
tags: ["HurdleRates"]
---

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

`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`

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

## Query parameters

- `propertyId` string, required
- `unitGroupIds` string[], required
- `from` string, date, required
- `to` string, date, required
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Return hurdle rates matching filter criteria.

- HurdleRatesListModel
  - `hurdleRates` HurdleRateItemModel[], nullable: List of rates
    - `propertyId` string, required: The property id
    - `unitGroupId` string, required: The unit group id
    - `date` string, date, required: Hurdle rate date
    - `amount` number, double, required: Monetary amount in currency units
    - `delta` number, double, required: Increment added to hurdle per UpSold, capped by Ceiling
    - `ceiling` integer, required: Reservations count after which Delta stops increasing
    - `maxSolds` integer, required: Maximum reservations allowed
    - `upSolds` integer, required: Reservations counter
    - `effectiveAmount` number, double, required: Effective amount calculated as Amount + Delta * UpSolds, capped by Ceiling
    - `created` string, date-time, required: The date when the resurce was created.<br />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>
    - `updated` string, date-time, required: The date when the resurce was last time updated.<br />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>
  - `count` integer, required: Total count of items

## Other responses

- `204`: There are no hurdle rates found.
- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work/revisions/97dec9512a17?raw)