---
title: "GET /v1/announcements/{announcementId}"
method: GET
path: "/v1/announcements/{announcementId}"
---

# GET /v1/announcements/{announcementId}

`GET /v1/announcements/{announcementId}`

## Request

- Base URL: `https://nhse-${ENV}-innovation-service-admin-functions.azurewebsites.net/api`
- URL: `https://nhse-${ENV}-innovation-service-admin-functions.azurewebsites.net/api/v1/announcements/{announcementId}`
- Auth: none declared

Get an announcement info.

## Path parameters

- `announcementId` string, uuid, required

## Response `200`

Announcement info retrieved.

- object
  - `id` string, uuid, required
  - `title` string, required
  - `userRoles` string[], required
  - `params` object, nullable, required
  - `startsAt` string, date-time, required
  - `expiresAt` string, date-time, nullable, required
  - `status` 'SCHEDULED' | 'ACTIVE' | 'DONE' | 'DELETED'
  - `filters` object, nullable, required
    - `section` string, required
    - `question` string, required
    - `answers` string[]
  - `sendEmail` boolean, required
  - `type` 'LOG_IN' | 'HOMEPAGE'

## Other responses

- `400`: Bad request
- `401`: Not authorized
- `500`: An error occurred

## Changes

- **2024-11-07** `bf0b42ebdc02`: 4 breaking, 5 warning, 11 info
  - the response property `expiresAt` became nullable for the status `200`
  - the response property `filters` became nullable for the status `200`
  - the response property `params` became nullable for the status `200`
  - the `filters` response's property type changed from `array` to `object` for status `200`
  - …16 more
- **2024-08-29** `a794f49c303c`: 1 warning, 4 info
  - removed the optional property `template` from the response with the `200` status
  - added the optional property `filters` to the response with the `200` status
  - added the optional property `sendEmail` to the response with the `200` status
  - added the optional property `status` to the response with the `200` status
  - …1 more
- **2024-08-29** `c46ea115c144`: 3 warning, 1 info
  - added the new `DEPRECATED` enum value to the `template` response property for the response status `200`
  - added the new `FILTERED` enum value to the `template` response property for the response status `200`
  - added the new `GENERIC` enum value to the `template` response property for the response status `200`
  - removed the `0` enum value from the `template` response property for the response status `200`
- …earlier changes not shown

[Operation history](https://skmtc.dev/nhs/apis/admin-api-nhs-innovation-service/changes/v1/announcements/:announcementId/get.md)

---

[API](https://skmtc.dev/nhs/apis/admin-api-nhs-innovation-service.md) - [All operations](https://skmtc.dev/nhs/apis/admin-api-nhs-innovation-service/llms.txt) - [OpenAPI document](https://skmtc.dev/nhs/apis/admin-api-nhs-innovation-service/revisions/97dbf652314e?raw)