Notices to the workspace. Who each one reaches is decided by an audience the API does not expose, so target_type is as much as this tells you about distribution.
List announcement categories
GET/v1/announcement_categories
Query parameters
| Name | Type | Required | Description |
|---|
limit | integer | No | Page size. Values above 100 are clamped. |
starting_after | string | No | Opaque cursor from a previous response’s next_cursor. |
Responses
| Status | Meaning |
|---|
200 | A page of announcement categories. |
401 | The API key is missing, malformed, revoked or expired. |
403 | The key does not carry the required scopes. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
Retrieve an announcement category
GET/v1/announcement_categories/{id}
Path parameters
| Name | Type | Required | Description |
|---|
id | string | Yes | The identifier returned as id on the object. |
Responses
| Status | Meaning |
|---|
200 | The announcement category. |
401 | The API key is missing, malformed, revoked or expired. |
403 | The key does not carry the required scopes. |
404 | No such announcement category in this workspace. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
List announcements
GET/v1/announcements
Query parameters
| Name | Type | Required | Description |
|---|
limit | integer | No | Page size. Values above 100 are clamped. |
starting_after | string | No | Opaque cursor from a previous response’s next_cursor. |
updated_since | timestamp | No | Return records changed at or after this instant. Tracks the record itself, not its child collections. |
category_id | string | No | Only announcements in this category. |
status | string | No | Only announcements in this state. |
priority | string | No | Only announcements at this priority. |
Responses
| Status | Meaning |
|---|
200 | A page of announcements. |
401 | The API key is missing, malformed, revoked or expired. |
403 | The key does not carry the required scopes. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
Retrieve an announcement
GET/v1/announcements/{id}
Path parameters
| Name | Type | Required | Description |
|---|
id | string | Yes | The identifier returned as id on the object. |
Responses
| Status | Meaning |
|---|
200 | The announcement. |
401 | The API key is missing, malformed, revoked or expired. |
403 | The key does not carry the required scopes. |
404 | No such announcement in this workspace. |
429 | Rate limit exceeded. See the RateLimit-* headers. |