---
title: "Get Alerts"
method: GET
path: "/alerts"
---

# Get Alerts

`GET /alerts`

## Request

- Base URL: `https://rooms.aero/partnerapi`
- URL: `https://rooms.aero/partnerapi/alerts`
- Auth: API key in header `Partner-Authorization`

Lists the alerts on your rooms.aero account, newest first. Alerts are created and deleted at https://rooms.aero/alerts; the API is read-only. Expired one-off alerts are left out unless include_expired is set. Requires a Pro user's API key.

## Query parameters

- `include_expired` boolean
- `skip` integer
- `take` integer

## Response `200`

200

- AlertList: A page of alerts.
  - `data` Alert[]
    - `id` string: Identifier for the alert.
    - `hotel_id` string: The hotel being watched.
    - `hotel` Hotel: One property in one loyalty program. The same object is returned by every endpoint that mentions a hotel.
      - `id` string: rooms.aero's identifier for the hotel. Use it as hotel_id on the other endpoints.
      - `source` string: The loyalty program key. The keys are listed on the Concepts page.
      - `program` string: The loyalty program's display name.
      - `name` string: Hotel name.
      - `brand` string: Program-specific brand code. The Concepts page maps codes to names.
      - `award_category` string: Program-specific award category, for programs with an award chart. Empty otherwise.
      - `address` string: Street address as published by the program.
      - `city` string: City.
      - `state` string: State, province or region; may be empty.
      - `country` string: Country, as a display name.
      - `latitude` number: Latitude in decimal degrees.
      - `longitude` number: Longitude in decimal degrees.
      - `image_url` string: A representative photo, when the program publishes one.
      - `description` string: Short description from the program; may be empty.
      - `internal_id` string: The program's own property code (Hilton ctyhocn, Hyatt spirit code, Marriott property code, and so on).
      - `open` boolean: Whether the property is open.
      - `url` string: The hotel's page on rooms.aero.
      - `lowest_award` integer, nullable: The cheapest award, in points, seen for any upcoming date in the last two weeks. Null when none is known. Populated by Get Hotels and Search; omitted from availability rows.
      - `standard_award_availability_percent` integer, nullable: Share of checked upcoming dates with any award available, over standard_award_availability_window_days. Null until enough dates have been checked.
      - `standard_award_availability_window_days` integer, nullable: The window the percentage was measured over.
      - `standard_award_availability_updated_at` string, date-time, nullable: When the percentage was last recomputed. RFC 3339 timestamp.
      - `last_checked_at` string, date-time, nullable: When the property's rates were last retrieved. Null if never. RFC 3339 timestamp.
      - `created_at` string, date-time: When rooms.aero started tracking the hotel. RFC 3339 timestamp.
      - `updated_at` string, date-time: When the hotel record last changed. RFC 3339 timestamp.
    - `date_type` 'fixed_date' | 'date_range' | 'any_date': fixed_date, date_range or any_date.
    - `arrival_date_start` string: First acceptable check-in date (YYYY-MM-DD). Empty for any_date; equal to arrival_date_end for fixed_date.
    - `arrival_date_end` string: Last acceptable check-in date (YYYY-MM-DD). Empty for any_date.
    - `num_nights` integer: Length of stay the alert watches, 1 to 5.
    - `alert_mode` 'one_off' | 'continuous': one_off fires once and then expires; continuous keeps notifying about new or cheaper matches until deleted.
    - `channel` string: Delivery channel. API alerts are always email.
    - `email_address` string: The account email the alert is delivered to.
    - `standard_room` boolean: Match standard room awards.
    - `suite_room` boolean: Match suite awards.
    - `max_points` integer: Highest acceptable award, in points. 0 means any price.
    - `expired` boolean: Whether a one-off alert has already fired.
    - `created_at` string, date-time: When the alert was created. RFC 3339 timestamp.
    - `updated_at` string, date-time: When the alert last changed. RFC 3339 timestamp.
  - `count` integer: Number of items in this response.
  - `has_more` boolean: Whether another page exists.
  - `more_url` string: URL of the next page. Omitted on the last page.

## Other responses

- `401`: Missing, unknown or unsubscribed credentials: missing_partner_key, bad_partner_key, bad_partner_token, invalid_scope or user_subscription_expired
- `403`: Not a Pro user's key
- `429`: Daily quota exhausted

---

[API](https://skmtc.dev/seats/apis/rooms-api.md) - [All operations](https://skmtc.dev/seats/apis/rooms-api/llms.txt) - [OpenAPI document](https://skmtc.dev/seats/apis/rooms-api/revisions/e164f8ea0b28?raw)