Notifications
List Notifications
List your notifications, newest first, with likes and follows grouped.
GET
List Notifications
List your notifications, newest first.
The first entry reads “Player Two and Alice liked your post”.
Query parameters
Behavior
- Results are paginated.
limitcounts raw notifications before grouping, so a page can hold fewer entries thanlimit. - Likes, comment likes and follows are grouped, so one entry can stand for several events. Read
actor_countandpost_countinstead of assuming one entry is one person.- Likes on the same post group together:
actor_countis how many people liked it. - One person liking several of your posts groups together:
post_countis how many posts. - Comment likes group by comment. Follows group together. Comments never group.
- Read and unread notifications never share a group, and grouping only happens within one page.
- Likes on the same post group together:
actorsholds up to 10 users even whenactor_countis higher. Suspended actors are left out ofactorsbut still counted.typeisfollow,like,comment,comment_like,mentionorpost_sharedon the social tab, and a system type such aspost_auto_moderatedorreport_receivedotherwise. New types can appear; ignore ones you do not know.mentionfires when someone @-mentions you in a post description or a comment.post_sharedfires when someone gives you access to a private post. Neither can be turned off.bodyis the comment text forcomment,comment_likeandmention. Checktypebefore rendering it.post_textis the related post’s title, falling back to its description.post_thumbnail_urlis a thumbnail of it, ornullfor a video without one. Both arenullon moderated posts.- If the related post is no longer visible to you,
post_thumbnail_url,post_textandbodyare allnull.bodyis alsonullwhen every actor on the entry is suspended. - Shares a rate limit bucket with the other notification endpoints: 60 requests per minute.
Examples
Responses
Errors
Authorizations
Your relay key from snipp.gg/settings/relay
Query Parameters
social or system. Omit for both.
Available options:
social, system Items per page, 1 to 100.
Required range:
1 <= x <= 100next_cursor from the previous page.