API reference

Notifications

9 endpoints under /v1/notifications.

List Notifications

get/v1/notifications

Query parameters

unread_onlybooleanoptional
beforestring (date-time)optional
kindsstringoptional
comma-separated kinds
proposal_idstring (uuid)optional

Headers

X-Organization-IDstringoptional

Failures return the error envelope; branch on error_code.

Request

Response

Dismiss

post/v1/notifications/{notification_id}/dismiss

Path parameters

notification_idstring (uuid)required

Headers

X-Organization-IDstringoptional

Failures return the error envelope; branch on error_code.

Request

Response

Mark Read

post/v1/notifications/{notification_id}/read

Path parameters

notification_idstring (uuid)required

Headers

X-Organization-IDstringoptional

Failures return the error envelope; branch on error_code.

Request

Response

Get Org Policies

get/v1/notifications/org-policies

Headers

X-Organization-IDstringoptional

Failures return the error envelope; branch on error_code.

Request

Response

Update Org Policies

patch/v1/notifications/org-policies

Headers

X-Organization-IDstringoptional

Request body

policiesobject[]required

Failures return the error envelope; branch on error_code.

Request

Response

Get Preferences

get/v1/notifications/preferences

Headers

X-Organization-IDstringoptional

Failures return the error envelope; branch on error_code.

Request

Response

Update Preferences

patch/v1/notifications/preferences

Headers

X-Organization-IDstringoptional

Request body

kindsobject[]optional
settingsobjectoptional

Failures return the error envelope; branch on error_code.

Request

Response

Read All

post/v1/notifications/read-all

Headers

X-Organization-IDstringoptional

Failures return the error envelope; branch on error_code.

Request

Response

Unread Count

get/v1/notifications/unread-count

Headers

X-Organization-IDstringoptional

Failures return the error envelope; branch on error_code.

Request

Response