---
title: "List Heads Ups"
method: POST
path: "/announcements/v1/announcement:ListHeadsUpManage"
tags: ["Heads Up"]
---

# List Heads Ups

`POST /announcements/v1/announcement:ListHeadsUpManage`

## Request body

- S12AnnouncementsV1ListHeadsUpManageRequest — The parameters for `ListHeadsUpManage`
  - `page_size` integer — Optional. Number of HeadsUps to be returned in a single request. Maximum 100. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. For example: '20'
  - `page_token` string — Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call. For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='
  - `sort_field` 'SORT_FIELD_UNKNOWN_UNSPECIFIED' | 'SORT_FIELD_PUBLISHED_AT' | 'SORT_FIELD_TITLE' — - SORT_FIELD_UNKNOWN_UNSPECIFIED: Defaults to published_at
  - `sort_direction` 'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'
  - `search_value` string — Optional. Search value that will Search on Title & any other relevant field.
  - `filters` S12AnnouncementsV1ListHeadsUpManageRequestFilter
    - `group_ids` string[]
    - `user_ids` string[]
    - `completed` 'COMPLETED_FILTER_UNKNOWN_NONE_UNSPECIFIED' | 'COMPLETED_FILTER_HAS_COMPLETED' | 'COMPLETED_FILTER_HAS_NOT_COMPLETED'
    - `author_ids` string[]
    - `statuses` S12AnnouncementsV1ListHeadsUpManageRequestFilterStatusFilter[]

## Response `200`

A successful response.

- S12AnnouncementsV1ListHeadsUpManageResponse — Result returned from `ListHeadsUpManage`
  - `heads_ups` S12AnnouncementsV1HeadsUpManageListItem[] — List of HeadsUps
    - `id` string — An ID uniquely identifying this Heads Up.
    - `title` string — Title of the Heads Up
    - `published_at` string, date-time — Timestamp representing the instance this Heads Up was published.
    - `author_id` string — ID of the author who originally created the Announcement.
    - `author_name` string — Name of the author who originally created the Announcement.
    - `viewed_count` integer — Number of unique user views
    - `acknowledgement_count` integer — Number of unique acknowledgement count
    - `has_acknowledgement` boolean — Defines whether or not a Heads Up requires an acknowledgement
    - `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.
    - `assigned_users_count` integer — The number of users who are assigned this HeadsUp
    - `complete` boolean — Whether or not the HeadsUp has been completed by all assignee's
    - `message_count` integer — MessageCount represents the total number of comments on this Heads Up.
    - `is_comments_disabled` boolean — Whether or not comments are disabled on this HeadsUp
    - `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_reactions_disabled` boolean — Whether or not reactions are disabled for this Heads Up
    - `reaction_count` integer — Number of reactions on the HeadsUp
  - `next_page_token` string — If there are more results than those appearing in this response, then `next_page_token` is included. If empty then there are no more results. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`. For Example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='
  - `total` integer — Total number of HeadsUps found

## 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)