> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snipp.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# List Notifications

> List your notifications, newest first, with likes and follows grouped.

List your notifications, newest first.

## Query parameters

| Parameter | Description |
| - | - |
| `tab` | `social` for follows, likes, comments, comment likes, mentions and shared posts. `system` for everything else. Omit for both. |
| `limit` | 1 to 100, default 30. |
| `cursor` | `next_cursor` from the previous page. |

## Behavior

* Results are [paginated](/concepts/pagination). `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

```bash theme={null}
curl "https://relay.snipp.gg/notifications?tab=social" \
  -H "relay-key: YOUR_RELAY_KEY"
```

## Responses

```json theme={null}
{
  "notifications": [
    {
      "id": "6f1d2c3b-4a59-4e68-9f70-8a1b2c3d4e5f",
      "type": "like",
      "post_code": "AbCd1234",
      "body": null,
      "read": false,
      "created_at": "2026-09-30T20:11:09.337Z",
      "actors": [
        {
          "id": "987654321098765432",
          "username": "playertwo",
          "nickname": "Player Two",
          "avatar": "https://cdn.snipp.gg/avatar.png",
          "verified": false,
          "plan": "free"
        },
        {
          "id": "555555555555555555",
          "username": "alice",
          "nickname": "Alice",
          "avatar": "https://i.snipp.gg/avatars/555555555555555555/0a1b2c3d4e5f60718293a4b5c6d7e8f9.webp",
          "verified": true,
          "plan": "ultra"
        }
      ],
      "actor_count": 2,
      "post_count": 1,
      "post_thumbnail_url": "https://i.snipp.gg/123456789012345678/a1b2c3d4e5f6789012345678abcdef01.png",
      "post_text": "Nice shot"
    },
    {
      "id": "7a2e3d4c-5b6a-4f79-8e01-9b2c3d4e5f60",
      "type": "comment",
      "post_code": "AbCd1234",
      "body": "Nice shot!",
      "read": true,
      "created_at": "2026-09-30T19:02:45.881Z",
      "actors": [
        {
          "id": "987654321098765432",
          "username": "playertwo",
          "nickname": "Player Two",
          "avatar": "https://cdn.snipp.gg/avatar.png",
          "verified": false,
          "plan": "free"
        }
      ],
      "actor_count": 1,
      "post_count": 1,
      "post_thumbnail_url": "https://i.snipp.gg/123456789012345678/a1b2c3d4e5f6789012345678abcdef01.png",
      "post_text": "Nice shot"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJ0IjoiMjAyNi0wOS0zMFQxOTowMjo0NS44ODFaIiwiayI6IjdhMmUzZDRjLTViNmEtNGY3OS04ZTAxLTliMmMzZDRlNWY2MCJ9"
}
```

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

## Errors

| Status | Type | When |
| - | - | - |
| `400` | `invalid_request` | Invalid `tab`, `limit` or `cursor` |
| `401` | `unauthorized` | Missing or invalid key |
| `403` | `suspended` | Your account is suspended |
| `429` | `rate_limited` | More than 60 requests per minute |


## OpenAPI

````yaml relay-reference/openapi.json GET /notifications
openapi: 3.0.0
info:
  title: Snipp.gg Relay API
  description: >-
    First-party Snipp API for the full user experience: uploads, posts,
    discover, likes, comments, notifications, blocks and profile management.
  version: 3.0.0
servers:
  - url: https://relay.snipp.gg
    description: Default. Load-balanced across regions. No upload cap.
  - url: https://eu-west-1.relay.snipp.gg
    description: EU West regional endpoint. Pins uploads and storage to EU West.
  - url: https://us-west-1.relay.snipp.gg
    description: US West regional endpoint. Pins uploads and storage to US West.
  - url: https://pulsar.snipp.gg
    description: Alternative host. Capped at 100 MB per upload.
security:
  - relayKeyAuth: []
paths:
  /notifications:
    get:
      summary: List Notifications
      description: List your notifications, newest first, with likes and follows grouped.
      operationId: listNotifications
      parameters:
        - name: tab
          in: query
          required: false
          description: '`social` or `system`. Omit for both.'
          schema:
            type: string
            enum:
              - social
              - system
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: Success
          headers:
            request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                type: object
                properties:
                  notifications:
                    type: array
                    items:
                      $ref: '#/components/schemas/Notification'
                  has_more:
                    type: boolean
                  next_cursor:
                    type: string
                    nullable: true
                required:
                  - notifications
                  - has_more
                  - next_cursor
              example:
                notifications:
                  - id: 6f1d2c3b-4a59-4e68-9f70-8a1b2c3d4e5f
                    type: like
                    post_code: AbCd1234
                    body: null
                    read: false
                    created_at: '2026-09-30T20:11:09.337Z'
                    actors:
                      - id: '987654321098765432'
                        username: playertwo
                        nickname: Player Two
                        avatar: https://cdn.snipp.gg/avatar.png
                        verified: false
                        plan: free
                      - id: '555555555555555555'
                        username: alice
                        nickname: Alice
                        avatar: >-
                          https://i.snipp.gg/avatars/555555555555555555/0a1b2c3d4e5f60718293a4b5c6d7e8f9.webp
                        verified: true
                        plan: ultra
                    actor_count: 2
                    post_count: 1
                    post_thumbnail_url: >-
                      https://i.snipp.gg/123456789012345678/a1b2c3d4e5f6789012345678abcdef01.png
                    post_text: Nice shot
                  - id: 7a2e3d4c-5b6a-4f79-8e01-9b2c3d4e5f60
                    type: comment
                    post_code: AbCd1234
                    body: Nice shot!
                    read: true
                    created_at: '2026-09-30T19:02:45.881Z'
                    actors:
                      - id: '987654321098765432'
                        username: playertwo
                        nickname: Player Two
                        avatar: https://cdn.snipp.gg/avatar.png
                        verified: false
                        plan: free
                    actor_count: 1
                    post_count: 1
                    post_thumbnail_url: >-
                      https://i.snipp.gg/123456789012345678/a1b2c3d4e5f6789012345678abcdef01.png
                    post_text: Nice shot
                has_more: true
                next_cursor: >-
                  eyJ0IjoiMjAyNi0wOS0zMFQxOTowMjo0NS44ODFaIiwiayI6IjdhMmUzZDRjLTViNmEtNGY3OS04ZTAxLTliMmMzZDRlNWY2MCJ9
        '400':
          $ref: '#/components/responses/E400'
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '405':
          $ref: '#/components/responses/E405'
        '429':
          $ref: '#/components/responses/E429'
        '500':
          $ref: '#/components/responses/E500'
components:
  parameters:
    Limit:
      name: limit
      in: query
      required: false
      description: Items per page, 1 to 100.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 30
    Cursor:
      name: cursor
      in: query
      required: false
      description: '`next_cursor` from the previous page.'
      schema:
        type: string
  headers:
    RequestId:
      description: Unique ID for the request. Include it when contacting support.
      schema:
        type: string
        format: uuid
  schemas:
    Notification:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          description: >-
            `follow`, `like`, `comment`, `comment_like`, `mention`,
            `post_shared`, or a system type such as `post_auto_moderated` or
            `report_received`.
        post_code:
          type: string
          nullable: true
        body:
          type: string
          nullable: true
        read:
          type: boolean
        created_at:
          type: string
          format: date-time
        actors:
          type: array
          items:
            $ref: '#/components/schemas/UserRef'
          description: Up to 10.
        actor_count:
          type: integer
        post_count:
          type: integer
        post_thumbnail_url:
          type: string
          nullable: true
        post_text:
          type: string
          nullable: true
      required:
        - id
        - type
        - post_code
        - body
        - read
        - created_at
        - actors
        - actor_count
        - post_count
        - post_thumbnail_url
        - post_text
    UserRef:
      type: object
      properties:
        id:
          type: string
          description: User ID (snowflake).
        username:
          type: string
          nullable: true
        nickname:
          type: string
          nullable: true
        avatar:
          type: string
          description: Avatar URL. Falls back to `https://cdn.snipp.gg/avatar.png`.
        verified:
          type: boolean
        plan:
          $ref: '#/components/schemas/Plan'
      required:
        - id
        - username
        - nickname
        - avatar
        - verified
        - plan
      description: A user embedded inside another resource.
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - error
      description: Every non-2xx response has this body.
    Plan:
      type: string
      enum:
        - free
        - plus
        - ultra
    ErrorDetail:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ErrorType'
        message:
          type: string
          description: Human-readable sentence. Do not match on it; use `type`.
        username:
          type: string
          description: >-
            `suspended` on `GET /users/{id}` only: the suspended user's
            username.
        quota:
          type: integer
          description: >-
            `quota_exceeded` only: the limit, in bytes for the weekly quota or
            minutes for priority minutes.
        used:
          type: integer
          description: >-
            `quota_exceeded` only: usage in the current window, in the same unit
            as `quota`.
        resets_at:
          type: string
          format: date-time
          description: '`quota_exceeded` only: when the window resets.'
          nullable: true
        failed:
          type: array
          items:
            $ref: '#/components/schemas/FailedFile'
          description: '`upload_failed` only: one entry per file.'
      required:
        - type
        - message
    ErrorType:
      type: string
      enum:
        - invalid_request
        - unauthorized
        - forbidden
        - suspended
        - blocked
        - moderated
        - plan_required
        - not_found
        - method_not_allowed
        - file_too_large
        - unsupported_type
        - quota_exceeded
        - rate_limited
        - upload_failed
        - internal
        - unavailable
      description: Machine-readable error category. See [Errors](/concepts/errors).
    FailedFile:
      type: object
      properties:
        index:
          type: integer
          description: Zero-based position of the file in the request.
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - index
        - error
      description: >-
        A file that was not stored. `error` has the same shape as a top-level
        error.
  responses:
    E400:
      description: Invalid request
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E401:
      description: Missing or invalid key
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E403:
      description: Not allowed
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E405:
      description: Method not allowed
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
        Allow:
          description: Methods this path accepts.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E429:
      description: Rate limited
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E500:
      description: Internal error
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    relayKeyAuth:
      type: apiKey
      in: header
      name: relay-key
      description: Your relay key from snipp.gg/settings/relay

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.