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

# List Heads Up users

`POST /announcements/v1/announcement:ListHeadsUpUsers`

## Request body

- S12AnnouncementsV1ListHeadsUpUsersRequest — The parameters for `ListHeadsUpUsers`
  - `heads_up_id` string, required — UUID used to look up HeadsUp.
  - `page_size` integer — Optional. Number of HeadsUps to be returned in a single request. Maximum 100. Non-positive values are ignored.
  - `offset` integer — Number of users to offset, used with page_size indicates what page is displayed
  - `sort_field` 'SORT_FIELD_UNKNOWN_UNSPECIFIED' | 'SORT_FIELD_NAME' | 'SORT_FIELD_EMAIL' | 'SORT_FIELD_VIEWED_AT' | 'SORT_FIELD_ACKNOWLEDGED_AT' — - SORT_FIELD_UNKNOWN_UNSPECIFIED: Defaults to NAME
  - `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` S12AnnouncementsV1ListHeadsUpUsersRequestFilter
    - `viewed` 'VIEWED_FILTER_UNKNOWN_NONE_UNSPECIFIED' | 'VIEWED_FILTER_HAS_VIEWED' | 'VIEWED_FILTER_HAS_NOT_VIEWED'
    - `acknowledged` 'ACKNOWLEDGED_FILTER_UNKNOWN_NONE_UNSPECIFIED' | 'ACKNOWLEDGED_FILTER_HAS_ACKNOWLEDGED' | 'ACKNOWLEDGED_FILTER_HAS_NOT_ACKNOWLEDGED'
    - `group_ids` string[]

## Response `200`

A successful response.

- S12AnnouncementsV1ListHeadsUpUsersResponse — Result returned from `ListHeadsUpUsers`
  - `users` S12AnnouncementsV1HeadsUpUserListItem[] — List of users
    - `id` string — ID of the user
    - `email` string — Users email
    - `first_name` string — Users first name
    - `last_name` string — Users last name
    - `profile_picture` 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.
    - `completion_details` S12AnnouncementsV1HeadsUpCompletionDetails
      - `viewed` boolean — Viewed determines whether or not the user has viewed the headsup before
      - `viewed_at` string, date-time — ViewedAt defines when a headsup was first viewed
      - `acknowledged` boolean — Acknowledged defines if a headsup has been acknowledged
      - `acknowledged_at` string, date-time — AcknowledgedAt defines when a headsup was acknowledged by the user
    - `status` boolean — Status represents whether or not the user has completed all necessary requirements
  - `total` integer — Total number of users 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)