Returns
#dataobjectAlways present
Your notifications and the number still unread.
Show 2 attributesHide attributes
notificationsobject[] | nullAlways present
Notices in the selected page.
Show 1 attributeHide attributes
itemsobject
A notice about your account or a resource you can access.
Show 8 attributesHide attributes
actionobject
Related dashboard destination, when there is one. May be omitted.
Show 2 attributesHide attributes
labelstringAlways present
Action's display text.
pathstringAlways present
Dashboard path, including any query selecting the organization or object.
atstring (date-time)Always present
When the notice was created.
idstringAlways present
Notification ID used to mark it read.
kindstringAlways present
Event category, such as a sharing or billing notice.
linestringAlways present
Notice's explanatory text.
organizationstring
Organization concerned. Omitted for your personal account. May be omitted.
readbooleanAlways present
Whether you have marked it read.
titlestringAlways present
Notice's heading.
unreadintegerAlways present
Your total number of unread notifications.
Errors
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- API key permission:
notification view.