Get a list of Rates Plans.

get

https://api.cloudbeds.com/rates/v1/rate-plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

offset

integer

≥ 0

Defaults to 0

The number of items to skip before starting to collect the result set. Used for pagination.

limit

integer

1 to 500

Defaults to 100

The maximum number of items to return in the response. Default is 100.

filters

string

Filter the list. Each clause is written field:operator:value, and multiple clauses are separated by a semicolon (;) — not a comma, which the sort parameter uses. Clauses are combined with AND; grouping and OR are not supported here. Supported fields: isActive (equals), isDerived (equals), promoCode (contains).

sort

string

Sort the list. Supported fields: createdAt, updatedAt, isActive. Multiple fields are separated by a comma (,), and each may carry a direction written as field:asc or field:desc; a field given on its own sorts ascending. When omitted, the list is returned newest first (createdAt descending).

includeTotal

boolean

Defaults to false

Return the total number of items matching the request, ignoring limit and offset. Boolean values are accepted case-insensitively, so true, TRUE, True and 1 all enable it.

Headers

x-property-id

string

required

A numeric, comma-separated string representing the property IDs, sent in the header.

Responses

200List of Rates Plans.

400Bad request response.

403Forbidden response.

500Internal server error.