Skip to content
API Docs

announcements

Fetch an array of announcements for a provider

Arguments

exclude_dismissed · Boolean · If true, only show announcements that client has not dismissed
keywords · String · Search announcements by name, title and description
after · Cursor · Cursor to fetch results after

Returns

[Announcement!]

Example 

query announcements(
  $exclude_dismissed: Boolean
  $keywords: String
  $offset: Int
  $should_paginate: Boolean
  $page_size: Int
  $after: Cursor
) {
  announcements(
    exclude_dismissed: $exclude_dismissed
    keywords: $keywords
    offset: $offset
    should_paginate: $should_paginate
    page_size: $page_size
    after: $after
  ) {
    active
    announcement_image_name
    announcement_image_url
    cursor
    description
    id
    last_toggled_at
    last_toggled_by
    name
    title
    user
    user_group_ids
    user_group_names
  }
}