---
title: "Search eligible rate plans and base rates with conflict info."
method: POST
path: "/smart-policies/v1/exceptions/eligible-rates/search"
tags: ["Smart Policy Exceptions"]
---

# Search eligible rate plans and base rates with conflict info.

`POST /smart-policies/v1/exceptions/eligible-rates/search`

## Request

- Base URL: `https://api.cloudbeds.com`
- URL: `https://api.cloudbeds.com/smart-policies/v1/exceptions/eligible-rates/search`
- Auth: OAuth 2
  - Authorization code: `https://api.cloudbeds.com/auth/oauth/authorize`
  - Token URL: `https://api.cloudbeds.com/auth/oauth/token` scopes: `read:rate`

## Headers

- `x-property-id` string, required

## Request body

- EligibleRatesRequestSchema
  - `limit` integer: The limit for the number of items to return (max 500)
  - `offset` integer: The offset for the current page of results
  - `startDate` string, date, required: Start date of the date range to filter rate plans.
  - `endDate` string, date, required: End date of the date range to filter rate plans.
  - `intervals` PolicyExceptionIntervalSchema[], required: List of exception intervals for conflict detection.
    - `startDate` string, date, required: Start date of the interval.
    - `endDate` string, date, required: End date of the interval.
    - `day0` boolean: Sunday (day 0) -- apply exception on this day of the week.
    - `day1` boolean: Monday (day 1) -- apply exception on this day of the week.
    - `day2` boolean: Tuesday (day 2) -- apply exception on this day of the week.
    - `day3` boolean: Wednesday (day 3) -- apply exception on this day of the week.
    - `day4` boolean: Thursday (day 4) -- apply exception on this day of the week.
    - `day5` boolean: Friday (day 5) -- apply exception on this day of the week.
    - `day6` boolean: Saturday (day 6) -- apply exception on this day of the week.
  - `exceptionId` string, nullable: Exception ID to exclude from conflict detection (when editing an existing exception).

## Response `200`

Eligible rate plans and base rates with conflict info.

- EligibleRatesResponseSchema
  - `total` integer, required: The total number of items available.
  - `limit` integer, required: The limit for the number of items to return.
  - `offset` integer, required: The offset for the current page of results.
  - `data` EligibleRateItemSchema[], required: Eligible rates for exception creation (rate plans and base rates combined).
    - `name` string, required: Name of the rate plan or room type.
    - `type` string, required: Type of rate: "rate_plan" or "base_rate".
    - `packageId` string, nullable: Package/rate plan ID. Present only when type is "rate_plan".
    - `roomTypeId` string, nullable: Room type ID. Present only when type is "base_rate".
    - `policyId` string, nullable: Smart policy ID associated with this rate plan, if any. Always null for base rates.
    - `conflict` EligibleRateConflictSchema
      - `exceptionId` string, required: ID of the blocking exception.
      - `exceptionName` string, required: Name of the blocking exception.

## Other responses

- `400`: Bad request response.
- `403`: Forbidden response.
- `500`: Internal server error.

---

[API](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2.md) - [All operations](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2/revisions/69bffac143cc?raw)
