Skip to main content
GET
List Notifications
List your notifications, newest first.

Query parameters

Behavior

  • Results are paginated. limit counts raw notifications before grouping, so a page can hold fewer entries than limit.
  • Likes, comment likes and follows are grouped, so one entry can stand for several events. Read actor_count and post_count instead of assuming one entry is one person.
    • Likes on the same post group together: actor_count is how many people liked it.
    • One person liking several of your posts groups together: post_count is 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.
  • actors holds up to 10 users even when actor_count is higher. Suspended actors are left out of actors but still counted.
  • type is follow, like, comment, comment_like, mention or post_shared on the social tab, and a system type such as post_auto_moderated or report_received otherwise. New types can appear; ignore ones you do not know.
  • mention fires when someone @-mentions you in a post description or a comment. post_shared fires when someone gives you access to a private post. Neither can be turned off.
  • body is the comment text for comment, comment_like and mention. Check type before rendering it.
  • post_text is the related post’s title, falling back to its description. post_thumbnail_url is a thumbnail of it, or null for a video without one. Both are null on moderated posts.
  • If the related post is no longer visible to you, post_thumbnail_url, post_text and body are all null. body is also null when every actor on the entry is suspended.
  • Shares a rate limit bucket with the other notification endpoints: 60 requests per minute.

Examples

Responses

The first entry reads “Player Two and Alice liked your post”.

Errors

Authorizations

relay-key
string
header
required

Your relay key from snipp.gg/settings/relay

Query Parameters

tab
enum<string>

social or system. Omit for both.

Available options:
social,
system
limit
integer
default:30

Items per page, 1 to 100.

Required range: 1 <= x <= 100
cursor
string

next_cursor from the previous page.

Response

Success

notifications
object[]
required
has_more
boolean
required
next_cursor
string | null
required