List Announcements

Beta

GET/v1/messaging/announcements

This endpoint is idempotent. Learn more

Returns the broadcast announcements currently active for the caller, most recent first.

Permissions requiredValues:messaging:read

The role behind your API key or agent must grant every one of these permissions.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

include[]optional arrayenumValues:resource

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of announcement

Resources in this page.

idstring

Announcement ID.

objectstringenumValues:announcement

Resource type identifier.

scopestringenumValues:accountplatform

Reach of the announcement.

account: shown only to users within this account.
platform: shown to every user across all accounts.

categorystringenumValues:chat.messagechat.mentionchat.added

Category of the announcement.

titlestring

Human-readable title.

bodystringnullable

Preview/body text.

statusstringenumValues:unseenseenread

Lifecycle status of the announcement for the calling actor, derived from their seen/read/dismissed receipt.

unseen: not yet surfaced in the caller's feed.
seen: surfaced in the feed but not yet opened.
read: opened by the caller.
dismissed: dismissed by the caller.

prioritystringenumValues:lownormalhigh

Delivery priority.

resourceentityExpandablenullable

The app resource this announcement links to.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

publish_atstring (date-time)

When the announcement becomes visible in the feed.

expires_atstring (date-time)nullable

When the announcement stops being shown.

seen_atstring (date-time)nullable

When the calling actor first saw the announcement.

read_atstring (date-time)nullable

When the calling actor opened the announcement.

dismissed_atstring (date-time)nullable

When the calling actor dismissed the announcement.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

Responses

200

Successful response for List Announcements

List Announcements

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listAnnouncement = await client.messaging.announcements.list();

console.log(listAnnouncement.data);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listAnnouncement = await client.messaging.announcements.list();

console.log(listAnnouncement.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/announcements?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYW5fMDFjNGQ1ZTZmN2E4YjljMGQxZTJmM2E0IiwiZCI6ImYifQ.l-yle3uA5hxBDvQNb1jLWMr0ixollz6EiFbbpxjpzfU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "an_01c4d5e6f7a8b9c0d1e2f3a4",
      "object": "announcement",
      "scope": "account",
      "category": "order.updated",
      "title": "Scheduled maintenance",
      "body": "The platform will be briefly unavailable tonight at 2am UTC.",
      "status": "unseen",
      "priority": "normal",
      "resource": null,
      "publish_at": "2026-05-10T00:00:00Z",
      "expires_at": null,
      "seen_at": null,
      "read_at": null,
      "dismissed_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/announcements?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYW5fMDFjNGQ1ZTZmN2E4YjljMGQxZTJmM2E0IiwiZCI6ImYifQ.l-yle3uA5hxBDvQNb1jLWMr0ixollz6EiFbbpxjpzfU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "an_01c4d5e6f7a8b9c0d1e2f3a4",
      "object": "announcement",
      "scope": "account",
      "category": "order.updated",
      "title": "Scheduled maintenance",
      "body": "The platform will be briefly unavailable tonight at 2am UTC.",
      "status": "unseen",
      "priority": "normal",
      "resource": null,
      "publish_at": "2026-05-10T00:00:00Z",
      "expires_at": null,
      "seen_at": null,
      "read_at": null,
      "dismissed_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Announcements

Authorization

Query Parameters

Returns

Responses