# fyi.opensocial.listNotifications

> The caller's Activity, newest first, from every group on this host they're in: what answers something of theirs, what names them, and, where they asked for everything new, each new event or thread. Only what they may still read, as it is now.

- Kind: query
- Authority: opensocial.fyi
- Lexicon: 1
- Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listNotifications)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listNotifications/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listNotifications/analytics)

## Query (`fyi.opensocial.listNotifications`)

Type: query · GET

### Parameters (query string)

- `cursor` (string)
- `limit` (integer)
  - Constraints: minimum: 1, maximum: 100, default: 50

### Output (application/json)

- `cursor` (string)
- `notifications` (array, required)
  - `items` (ref)
    - Reference: `#notification`

## #notification (`fyi.opensocial.listNotifications#notification`)

Type: object

### Properties

- `author` (ref, required)
  - Reference: `fyi.opensocial.defs#actorView`
- `channel` (ref, required)
  - Reference: `#placeName`
- `group` (ref, required)
  - Reference: `fyi.opensocial.defs#groupViewBasic`
- `id` (string, required)
- `indexedAt` (string · datetime, required)
- `isRead` (boolean, required)
- `reason` (string, required): Why it's in the caller's Activity: it names them, it answers something of theirs, or it's new where they asked for everything.
  - Constraints: knownValues: mention | reply | new
- `record` (ref, required)
  - Reference: `#recordGist`
- `subject` (ref): With a reply, what it answers.
  - Reference: `#recordGist`
- `tab` (ref, required)
  - Reference: `#tabName`

## #placeName (`fyi.opensocial.listNotifications#placeName`)

Type: object

### Properties

- `name` (string, required)
- `slug` (string, required)

## #recordGist (`fyi.opensocial.listNotifications#recordGist`)

Type: object

### Properties

- `text` (string): The start of what it says.
  - Constraints: maxLength: 300
- `title` (string): Its title or name, if it has one.
  - Constraints: maxLength: 300
- `uri` (string · at-uri, required)

## #tabName (`fyi.opensocial.listNotifications#tabName`)

Type: object

### Properties

- `slug` (string, required)
- `template` (string): Which template it's made from, for its icon.
- `title` (string, required)

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The caller's Activity, newest first, from every group on this host they're in: what answers something of theirs, what names them, and, where they asked for everything new, each new event or thread. Only what they may still read, as it is now.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "notifications": {
              "items": {
                "ref": "#notification",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "notifications"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "params"
      },
      "type": "query"
    },
    "notification": {
      "properties": {
        "author": {
          "ref": "fyi.opensocial.defs#actorView",
          "type": "ref"
        },
        "channel": {
          "ref": "#placeName",
          "type": "ref"
        },
        "group": {
          "ref": "fyi.opensocial.defs#groupViewBasic",
          "type": "ref"
        },
        "id": {
          "type": "string"
        },
        "indexedAt": {
          "format": "datetime",
          "type": "string"
        },
        "isRead": {
          "type": "boolean"
        },
        "reason": {
          "description": "Why it's in the caller's Activity: it names them, it answers something of theirs, or it's new where they asked for everything.",
          "knownValues": [
            "mention",
            "reply",
            "new"
          ],
          "type": "string"
        },
        "record": {
          "ref": "#recordGist",
          "type": "ref"
        },
        "subject": {
          "description": "With a reply, what it answers.",
          "ref": "#recordGist",
          "type": "ref"
        },
        "tab": {
          "ref": "#tabName",
          "type": "ref"
        }
      },
      "required": [
        "id",
        "group",
        "channel",
        "tab",
        "reason",
        "author",
        "record",
        "indexedAt",
        "isRead"
      ],
      "type": "object"
    },
    "placeName": {
      "properties": {
        "name": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        }
      },
      "required": [
        "slug",
        "name"
      ],
      "type": "object"
    },
    "recordGist": {
      "properties": {
        "text": {
          "description": "The start of what it says.",
          "maxLength": 300,
          "type": "string"
        },
        "title": {
          "description": "Its title or name, if it has one.",
          "maxLength": 300,
          "type": "string"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri"
      ],
      "type": "object"
    },
    "tabName": {
      "properties": {
        "slug": {
          "type": "string"
        },
        "template": {
          "description": "Which template it's made from, for its icon.",
          "type": "string"
        },
        "title": {
          "type": "string"
        }
      },
      "required": [
        "slug",
        "title"
      ],
      "type": "object"
    }
  },
  "id": "fyi.opensocial.listNotifications",
  "lexicon": 1
}
```