# ink.resenha.notification.listNotifications

> Requires the caller's service token. Only the caller's own.

- Kind: query
- Authority: notification.resenha.ink
- Lexicon: 1
- Published by [resenha.ink](https://lexicon.garden/identity/did:plc:v7itjf4h3sb5zuegiiskctqb), not the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.notification.listNotifications)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.notification.listNotifications/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.notification.listNotifications/analytics)

## Query (`ink.resenha.notification.listNotifications`)

Type: query · GET

### Parameters (query string)

- `cursor` (string): Where the previous page ended.
- `limit` (integer)
  - Constraints: minimum: 1, maximum: 100, default: 50

### Output (application/json)

- `cursor` (string): Where the previous page ended.
- `notifications` (array, required)
  - `items` (ref)
    - Reference: `#notification`
- `preferences` (ref)
  - Reference: `#preferences`
- `seenAt` (string · datetime)

## #notification (`ink.resenha.notification.listNotifications#notification`)

Type: object

### Properties

- `author` (string · did, required)
- `book` (object): For readingLike, readingComment and a Resenha reply: the caller's book.
- `indexedAt` (string · datetime, required)
- `kind` (string, required): like and quote group under their review; readingLike groups under the book record it's on, and readingComment is a comment on the caller reading a book; reply is to a comment of the caller's, on Bluesky (with thread), Popfeed, BookHive or Resenha (with thread, the book record).
  - Constraints: knownValues: follow | friendRequest | like | quote | reviewComment | reply | comicComment | readingLike | readingComment
- `review` (string · at-uri): The caller's review it groups under, when there is one: its post, Popfeed review or book record.
- `source` (string, required)
  - Constraints: knownValues: bluesky | popfeed | bookhive | resenha | sequential
- `subject` (string · at-uri): What it's about: the caller's post, review or comment.
- `text` (string)
  - Constraints: maxLength: 3000, maxGraphemes: 300
- `thread` (string · at-uri): For a reply to the caller's comment: the post the thread hangs from, some reader's review.
- `uri` (string · at-uri, required): The record that caused it.

## #preferences (`ink.resenha.notification.listNotifications#preferences`)

Type: object

### Properties

- `likes` (string, required): Whose likes and quotes are pushed to the caller's devices. They're always listed.
  - Constraints: knownValues: everyone | following | off

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Requires the caller's service token. Only the caller's own.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "Where the previous page ended.",
              "type": "string"
            },
            "notifications": {
              "items": {
                "ref": "#notification",
                "type": "ref"
              },
              "type": "array"
            },
            "preferences": {
              "ref": "#preferences",
              "type": "ref"
            },
            "seenAt": {
              "format": "datetime",
              "type": "string"
            }
          },
          "required": [
            "notifications"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "Where the previous page ended.",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "params"
      },
      "type": "query"
    },
    "notification": {
      "properties": {
        "author": {
          "format": "did",
          "type": "string"
        },
        "book": {
          "description": "For readingLike, readingComment and a Resenha reply: the caller's book.",
          "properties": {
            "hiveId": {
              "type": "string"
            },
            "title": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "indexedAt": {
          "format": "datetime",
          "type": "string"
        },
        "kind": {
          "description": "like and quote group under their review; readingLike groups under the book record it's on, and readingComment is a comment on the caller reading a book; reply is to a comment of the caller's, on Bluesky (with thread), Popfeed, BookHive or Resenha (with thread, the book record).",
          "knownValues": [
            "follow",
            "friendRequest",
            "like",
            "quote",
            "reviewComment",
            "reply",
            "comicComment",
            "readingLike",
            "readingComment"
          ],
          "type": "string"
        },
        "review": {
          "description": "The caller's review it groups under, when there is one: its post, Popfeed review or book record.",
          "format": "at-uri",
          "type": "string"
        },
        "source": {
          "knownValues": [
            "bluesky",
            "popfeed",
            "bookhive",
            "resenha",
            "sequential"
          ],
          "type": "string"
        },
        "subject": {
          "description": "What it's about: the caller's post, review or comment.",
          "format": "at-uri",
          "type": "string"
        },
        "text": {
          "maxGraphemes": 300,
          "maxLength": 3000,
          "type": "string"
        },
        "thread": {
          "description": "For a reply to the caller's comment: the post the thread hangs from, some reader's review.",
          "format": "at-uri",
          "type": "string"
        },
        "uri": {
          "description": "The record that caused it.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "kind",
        "source",
        "author",
        "indexedAt"
      ],
      "type": "object"
    },
    "preferences": {
      "properties": {
        "likes": {
          "description": "Whose likes and quotes are pushed to the caller's devices. They're always listed.",
          "knownValues": [
            "everyone",
            "following",
            "off"
          ],
          "type": "string"
        }
      },
      "required": [
        "likes"
      ],
      "type": "object"
    }
  },
  "description": "The caller's notifications from Bluesky, BookHive, Popfeed, comics and Resenha, newest first.",
  "id": "ink.resenha.notification.listNotifications",
  "lexicon": 1
}
```