---
title: "Search announcements"
method: GET
path: "/v1/Announcements"
tags: ["Announcements"]
---

# Search announcements

`GET /v1/Announcements`

Search for one or more announcements.

## Query parameters

- `search.announcement_id` integer[]
- `search.body_html` string[]
- `search.created_date_start` string, date-time
- `search.created_date_end` string, date-time
- `search.location` string[]
- `search.title` string[]
- `search.is_active` boolean
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsAnnouncement
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsAnnouncement[] — List of records returned.
    - `announcement_id` integer — Primary identifier for this announcement.
    - `created_date` string, date-time — Date the announcement was created.
    - `title` string, required — Title of the announcement.
    - `body_html` string, required — HTML body of the announcement.
    - `enabled` boolean, required — Whether the announcement is currently enabled.
    - `location` 'ALL' | 'AGENT_PORTAL' | 'CUSTOMER_PORTAL' — Location of the announcement.
    - `file_id` integer — File ID attached to the announcement.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

## Other responses

- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)