# List notifications

`GET /v1/notifications`

Your notifications, newest first. Archived ones only with archived: true.

Scope: `docs:read`.

## Request

```bash
curl "https://api.lydie.co/v1/notifications" \
  -H "Authorization: Bearer $LYDIE_TOKEN"
```

## Query parameters

- `workspaceId` (string, optional): (1–64 chars)
- `unread` (boolean, optional): Only unread ones. Default: `false`.
- `archived` (boolean, optional): Archived ones instead of the inbox. Default: `false`.
- `before` (string, optional): Page: notifications older than this id. (1–64 chars)
- `limit` (integer, optional): Default: `50`. (1–200)

## Response

- `notifications` (Notification[], required)
  - `id` (string, required): (1–64 chars)
  - `workspaceId` (string, required): (1–64 chars)
  - `kind` (string, required): One of: `mention`, `share`, `invitation_accepted`, `assigned`.
  - `documentId` (string, required, nullable)
  - `actorId` (string, required, nullable): Who caused it; null when unknown.
  - `data` (object, required): mention: { title, actorName, snippet }; share: { title, actorName, level }; invitation_accepted: { email, name, workspaceName, documentId? }; assigned: { title, actorName, propertyName, propertyId, databaseId }
  - `readAt` (string, required, nullable)
  - `archivedAt` (string, required, nullable)
  - `createdAt` (string, required)
- `unread` (integer, required)

```json
{
  "notifications": [
    {
      "id": "string",
      "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
      "kind": "mention",
      "documentId": null,
      "actorId": null,
      "data": {},
      "readAt": null,
      "archivedAt": null,
      "createdAt": "string"
    }
  ],
  "unread": -9007199254740991
}
```

Errors use the envelope described at https://developers.lydie.co/errors.md.