Skip to main content
GET
/
v1
/
announcements
/
{announcementId}
Get an announcement by id
curl --request GET \
  --url https://{host}/v2/workspaces/slug:ai-governance-v2/webhooks/v1/announcements/{announcementId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "orgSlug": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "content": "<string>",
  "icon": "<string>",
  "link": "<string>",
  "targets": {},
  "expires_at": "<string>",
  "createdBy": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

User-bound credential carrying an identity: either a session JWT or a user access token (at:*) generated from the user settings UI. Send as Authorization: Bearer <token>. Org API keys (iak_*) are not accepted here - they carry no user identity. Use the x-prismeai-api-key header instead (see OrgApiKeyAuth).

Path Parameters

​
announcementId
string
required

Announcement identifier.

Maximum string length: 64
Pattern: ^[a-zA-Z0-9_-]+$

Response

Announcement details.

Full announcement record stored in the announcements collection.

​
id
string
​
orgSlug
string | null
​
title
string
​
summary
string
​
content
string
​
icon
string
​
link
string
​
targets
object

Audience targeting object - validated and normalized server-side by internal/validate-announcement-targets. Common shape exposes roles, permissions, products, userIds.

​
status
enum<string>
Available options:
draft,
active,
archived
​
expires_at
string
​
createdBy
string
​
createdAt
string<date-time>
​
updatedAt
string<date-time>