Viewers

Learn how to query an update's viewers using the platform API

Within an update, users can reply and react, attach files, pin important messages to the top, and see who has viewed the conversation.

Queries

Get viewers

  • Required scope:updates:read
  • Returns an array containing metadata about one or a collection of an update's viewers
  • Must be nested within an updates query; can't be queried directly at the root
query {
  updates {
    viewers {
      user_id
      medium
      user {
        name
      }
    }
  }
}

Arguments

ArgumentTypeDescription
limitIntThe number of updates to return. The default is 100.
pageIntThe page number to get. Starts at 1.

Fields

FieldTypeDescriptionPossible Values
mediumString!The channel that the viewers saw the update from."email"
"mobile"
"web"
userUserThe user who viewed the update.
user_idID!The unique identifier of the user who viewed the update.