---
title: "Get a Heads Ups comments"
method: POST
path: "/announcements/v1/announcement:GetHeadsUpMessages"
tags: ["Heads Up"]
---

# Get a Heads Ups comments

`POST /announcements/v1/announcement:GetHeadsUpMessages`

## Request body

- S12AnnouncementsV1GetHeadsUpMessagesRequest — The parameters for `GetHeadsUpMessages`
  - `message_request` S12CommonGetMessagesRequest — The parameters for `GetMessages`
    - `page_size` integer — Optional. Number of messages 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='
    - `reference_id` string, required — The ID of the resource your are looking for messages for
    - `reference_type` 'MESSAGE_REFERENCE_TYPES_UNKNOWN_UNSPECIFIED' | 'MESSAGE_REFERENCE_TYPES_HEADS_UP', required — MessageReferenceTypes is a list of supported message reference types.
    - `parent_id` string — Optional. Parent_id represents the ID of the parent message if any.
    - `sort_direction` 'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'

## Response `200`

A successful response.

- S12AnnouncementsV1GetHeadsUpMessagesResponse — Result returned from `GetHeadsUpMessages`
  - `message_response` S12CommonGetMessagesResponse — The result of `GetMessages`
    - `messages` S12CommonMessage[] — All messages for a given resource
      - `id` string — An ID uniquely identifying this message.
      - `parent_id` string — Optional. parent_id represents the parent message this belongs too.
      - `reference_id` string — The ID of the resource you wish to comment on
      - `reference_type` 'MESSAGE_REFERENCE_TYPES_UNKNOWN_UNSPECIFIED' | 'MESSAGE_REFERENCE_TYPES_HEADS_UP' — MessageReferenceTypes is a list of supported message reference types.
      - `message` S12CommonMessageContent[] — The message being sent
        - `text` S12CommonTextMessage
          - `text` string
        - `mention` S12CommonMentionMessage
          - `mention_id` string
          - `mention_type` 'MENTION_TYPE_UNKNOWN' | 'MENTION_TYPE_USER' | 'MENTION_TYPE_ROLE' — MentionType the type of mention that is being used. This could be users/roles etc.
          - `text` string — Used as a response value but cannot be sent or edited.
      - `user_id` string — ID of the user who sent the message
      - `name` string — Name of the user who sent the message
      - `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.
      - `sent_at` string, date-time — Time the message was sent.
      - `reply_count` integer — Number of replies to this given message.
    - `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 Messages 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)