Notification Count

GET

Retrieve the total count of pending notifications for the current user.

A notification represents a message sent to a user to inform them of relevant actions or events within their workspace. Notifications are ephemeral and may be deleted when they are no longer needed. When a user has more than 1,000 pending notifications some old notifications will be deleted automatically.

Headers

x-integration-namestringOptional

The name of the calling system passed along as a header parameter

Response

This endpoint returns an object.
errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

True if the API call failed.

statusCodeenumOptional

The HTTP code of the response.

dataobjectOptional

Information about notifications for the current user.

A notification represents a message sent to a user to inform them of relevant actions or events within their workspace. Notifications are ephemeral and may be deleted when they are no longer needed. When a user has more than 1,000 pending notifications some old notifications will be deleted automatically.

Unread Notification Count
Built with