List ticker posts
GET/ticker.list
List the posts on the ticker, the strip that scrolls announcements, goals,
and wins across the Roam. The list includes posts members created in the
Roam app and posts integrations created through the API; compare each
post's authorId with user.id from token.info
to find your own.
Posts are returned in display order: the order people arranged them in the Roam app, not the order they were created. The ticker holds at most 50 posts, so every post comes back in one response; there is no pagination.
No webhooks fire when posts change. Call this endpoint to see the current posts.
Admins can turn the ticker off in Roam Administration (the "Ticker"
setting). While it is off, this call still succeeds, with enabled: false
and an empty messages list. Turning the ticker off permanently deletes
every post, and it starts empty when turned back on, so post IDs you saved
no longer exist.
Access: Organization only (API Key or OAuth with admin consent).
Personal tokens, including Personal Access Tokens, get 403
access_mode_not_supported.
Required scope: ticker:read
OpenAPI Spec: chat-v1.json
Responses
- 200
- 401
- 403
- 405
- 500
Ticker posts retrieved successfully
Presented invalid authentication credentials.
Forbidden. Common causes:
- Personal token (
access_mode_not_supported) - Token is missing
ticker:read(missing_scope) - The ticker is not available in this Roam (
ticker_not_available)
An unsupported method was requested.
An internal error occurred.