Back
get /v1/me/notifications

List my notifications

Returns the calling user's notifications (their Pivot Inbox), newest first, with who triggered each one, where it happened, the quoted text and a link to open it. By default it returns the Inbox: unread (NOTIFICATION_STATUS_RECEIVED) and read (NOTIFICATION_STATUS_OPEN) notifications. Pass statuses for unread only, snoozed or archived ones, types to narrow by kind (mentions are NOTIFICATION_TYPE_MENTIONED_MESSAGE, NOTIFICATION_TYPE_MENTIONED_YOU and NOTIFICATION_TYPE_BLOCK_CONTENT_MENTION), createdAfter/createdBefore for a time window, and query to match the quoted text. Each call reads at most 1,000 notifications, so a filtered page can hold fewer than limit items, even none, while hasMore is true: keep passing nextCursor as cursor until hasMore is false. Requires a user API key.

query params

cursorstring

Opaque cursor from a previous response's nextCursor. Omit for the newest notifications.

limitinteger

Maximum number of notifications to return. Default 50, maximum 100; larger values are reduced to 100.

statusesarray of strings

Statuses to return: NOTIFICATION_STATUS_RECEIVED (unread), NOTIFICATION_STATUS_OPEN (read), NOTIFICATION_STATUS_SNOOZED or NOTIFICATION_STATUS_ARCHIVED. Omit for the Inbox: unread and read.

Enum values:
NOTIFICATION_STATUS_UNSPECIFIED
NOTIFICATION_STATUS_RECEIVED
NOTIFICATION_STATUS_OPEN
NOTIFICATION_STATUS_SNOOZED
NOTIFICATION_STATUS_ARCHIVED
NOTIFICATION_STATUS_DELETED
typesarray of strings

Notification types to return (any type but NOTIFICATION_TYPE_UNSPECIFIED). Omit for every type.

Enum values:
NOTIFICATION_TYPE_UNSPECIFIED
NOTIFICATION_TYPE_COMMENTED_POST
NOTIFICATION_TYPE_REPLIED_POST
NOTIFICATION_TYPE_REACTED_POST
NOTIFICATION_TYPE_MENTIONED_YOU
NOTIFICATION_TYPE_ADDED_YOU
NOTIFICATION_TYPE_REMOVED_YOU
NOTIFICATION_TYPE_STARTED_AUDIO_ROOM
NOTIFICATION_TYPE_STARTED_VIDEO_ROOM
NOTIFICATION_TYPE_INVITED_TO_SPEAK
NOTIFICATION_TYPE_STREAMING_ROOM_SCHEDULED_SOON
NOTIFICATION_TYPE_STREAMING_ROOM_LIVE_NOW
NOTIFICATION_TYPE_REPLIED_MESSAGE
NOTIFICATION_TYPE_REPLIED_THREAD
NOTIFICATION_TYPE_REACTED_MESSAGE
NOTIFICATION_TYPE_MENTIONED_MESSAGE
NOTIFICATION_TYPE_DIRECT_MESSAGE
NOTIFICATION_TYPE_MULTIPLE_DIRECT_MESSAGE
NOTIFICATION_TYPE_STARTED_DIRECT_AUDIO
NOTIFICATION_TYPE_STARTED_DIRECT_VIDEO
NOTIFICATION_TYPE_REMINDER
NOTIFICATION_TYPE_BLOCK_COMMENT
NOTIFICATION_TYPE_BLOCK_COMMENT_REPLY
NOTIFICATION_TYPE_BLOCK_COMMENT_REACTED
NOTIFICATION_TYPE_BLOCK_CONTENT_MENTION
NOTIFICATION_TYPE_BLOCK_ASSIGNED
NOTIFICATION_TYPE_BLOCK_EVENT_INVITED
NOTIFICATION_TYPE_SPACE_INVITED
NOTIFICATION_TYPE_SPACE_REQUEST_GRANTED
NOTIFICATION_TYPE_SPACE_REQUEST_DENIED
NOTIFICATION_TYPE_SUBSCRIPTION_RENEWING_SOON
NOTIFICATION_TYPE_SUBSCRIPTION_RENEWAL_FAIL
NOTIFICATION_TYPE_SUBSCRIPTION_INITIAL_FAIL
NOTIFICATION_TYPE_SYSTEM
NOTIFICATION_TYPE_BLOCK_RESPONSE_NEW_ASSIGNMENT
NOTIFICATION_TYPE_BLOCK_RESPONSE_ASSIGNMENT_COMMENT
NOTIFICATION_TYPE_SINGLE_FILE_SENT
NOTIFICATION_TYPE_MULTIPLE_FILES_SENT
NOTIFICATION_TYPE_GOAL_COMPLETED
NOTIFICATION_TYPE_GOAL_CANCELED
NOTIFICATION_TYPE_DATABASE_ITEM_ASSIGNED
NOTIFICATION_TYPE_EVENT_STARTING_SOON
createdAfterstring

Only notifications created after this time.

createdBeforestring

Only notifications created before this time.

querystring

Only notifications whose quoted text contains this, ignoring case.

Responses

Was this guide helpful?