---
title: "Gets Heads Up"
method: GET
path: "/announcements/v1/announcement:GetHeadsUp"
tags: ["Heads Up"]
---

# Gets Heads Up

`GET /announcements/v1/announcement:GetHeadsUp`

## Query parameters

- `id` string, required

## Response `200`

A successful response.

- S12AnnouncementsV1HeadsUpResponse — Result returned from `GetHeadsUp`
  - `heads_up` S12AnnouncementsV1HeadsUp
    - `id` string — An ID uniquely identifying this message.
    - `created_at` string, date-time — Timestamp representing the instance this Announcement was originally created.
    - `modified_at` string, date-time — Timestamp representing the instance this Announcement was most recently modified.
    - `organisation_id` string — The ID of the organisation that this Announcement belongs to.
    - `deleted` boolean — Whether or not the Announcement has been soft deleted.
    - `title` string — The title of the Announcement.
    - `author_id` string — ID of the author who originally created the Announcement.
    - `author_name` string — Name of the author who originally created the Announcement.
    - `is_published` boolean — Whether or not the Announcement has been published, indicating that it can no longer undergo modifications.
    - `published_at` string, date-time — Timestamp representing the instance this Announcement was published.
    - `has_acknowledgement` boolean — Defines if it is required that a user taking the Announcement is required to explicitly acknowledge that they understand the content of the Announcement.
    - `description` string — Description of the heads up as provided by the user.
    - `video` S12CommonMedia
      - `id` string
      - `token` string
      - `filename` string — full file name, including file extension
      - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file.
    - `images` S12CommonMedia[] — Images are now held in HeadsUpMedia media. Deprecated in favour of media_ids
      - `id` string
      - `token` string
      - `filename` string — full file name, including file extension
      - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file.
    - `author_profile_image` S12CommonMedia
      - `id` string
      - `token` string
      - `filename` string — full file name, including file extension
      - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file.
    - `is_assigned` boolean — Whether or not the requesting user is assigned this Heads Up
    - `is_video_transcoded` boolean — Video transcoded state will be held in VideoMeta of an individual HeadsUpMedia media. Deprecated in favour of media_ids
    - `is_comments_disabled` boolean — Whether or not comments are disabled for this Heads Up
    - `media` S12AnnouncementsV1HeadsUpMedia[] — Media is a list of HeadsUpMedia objects associated with this HeadsUp
      - `media` S12CommonMedia
        - `id` string
        - `token` string
        - `filename` string — full file name, including file extension
        - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file.
      - `video` S12AnnouncementsV1VideoMeta
        - `video_duration` integer — Number of milliseconds in the video
        - `is_video_transcoded` boolean — Whether or not the video has been transcoded
      - `document` S12AnnouncementsV1DocumentMeta
        - `document_type` 'DOCUMENT_TYPE_UNKNOWN_UNSPECIFIED' | 'DOCUMENT_TYPE_PDF'
      - `linked_document` S12AnnouncementsV1LinkedDocument
        - `link_id` string — ID of the link relationship connecting this media to the asset.
        - `is_archived` boolean — Boolean flag indicating whether the linked media is archived.
        - `document_node_id` string — Document node ID the media came from.
        - `expiry_status` 'EXPIRY_STATUS_VALID' | 'EXPIRY_STATUS_EXPIRED' | 'EXPIRY_STATUS_EXPIRING_SOON' — The expiry status of an object based on its validity period.
        - `acknowledgement_type` 'ACKNOWLEDGEMENT_TYPE_UNSPECIFIED' | 'ACKNOWLEDGEMENT_TYPE_ACKNOWLEDGEMENT' | 'ACKNOWLEDGEMENT_TYPE_SIGNATURE' — The acknowledgement type for a linked node — used both as the requirement on a link and as the type recorded when a user acknowledges. UNSPECIFIED means no acknowledgement is required. - ACKNOWLEDGEMENT_TYPE_UNSPECIFIED: No acknowledgement required.
        - `acknowledged` boolean — Whether the requesting user has satisfied the acknowledgement requirement for this linked document's version. Always true when acknowledgement_type is ACKNOWLEDGEMENT_TYPE_UNSPECIFIED.
        - `acknowledged_at` string, date-time — Timestamp when the requesting user acknowledged this document. Only set when acknowledged is true.
    - `is_reactions_disabled` boolean — Whether or not reactions are disabled for this Heads Up

## Other responses

- `default` — An unexpected error response.

---

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