---
title: "List notifications"
method: POST
path: "/notifications.list"
tags: ["Notifications"]
---

# List notifications

`POST /notifications.list`

## Request

- Base URL: `https://app.getoutline.com/api`
- URL: `https://app.getoutline.com/api/notifications.list`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://app.getoutline.com/oauth/authorize`
    - Token URL: `https://app.getoutline.com/oauth/token` scopes: `read`, `write`

List the authenticated user's notifications, most recent first, optionally filtered by event type or archived status.

## Request body

- object
  - `offset` number
  - `limit` number
  - `eventType` string: Filter to notifications of a specific event type.
  - `archived` boolean: When true, only archived notifications are returned.

## Response `200`

OK

- object
  - `data` Notification[]
    - `id` string, uuid: Unique identifier for the object.
    - `event` string: The type of event that triggered the notification.
    - `userId` string, uuid: Identifier for the user the notification belongs to.
    - `actorId` string, uuid, nullable: Identifier for the user that triggered the notification, if any.
    - `actor` User
      - `id` string, uuid: Unique identifier for the object.
      - `name` string: The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
      - `avatarUrl` string, uri: The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
      - `color` string: A color representing the user, used in the UI for avatars without an image.
      - `email` string, email: The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
      - `role` 'admin' | 'member' | 'viewer' | 'guest'
      - `isSuspended` boolean: Whether this user has been suspended.
      - `lastActiveAt` string, date-time, nullable: The last time this user made an API request, this value is updated at most every 5 minutes.
      - `timezone` string, nullable: The timezone this user has registered.
      - `createdAt` string, date-time: The date and time that this user first signed in or was invited as a guest.
      - `updatedAt` string, date-time: The date and time that this user was last updated.
      - `deletedAt` string, date-time, nullable: The date and time that this user was deleted, if applicable.
      - `invitedBy` User (recursive)
    - `documentId` string, uuid, nullable: Identifier for the associated document, if any.
    - `collectionId` string, uuid, nullable: Identifier for the associated collection, if any.
    - `commentId` string, uuid, nullable: Identifier for the associated comment, if any.
    - `revisionId` string, uuid, nullable: Identifier for the associated revision, if any.
    - `viewedAt` string, date-time, nullable: Date and time the notification was marked as viewed, if it has been.
    - `archivedAt` string, date-time, nullable: Date and time the notification was archived, if it has been.
    - `createdAt` string, date-time: Date and time when this notification was created.
  - `pagination` Pagination
    - `offset` number
    - `limit` number
  - `policies` Policy[]
    - `id` string, uuid: Unique identifier for the object this policy references.
    - `abilities` object: The abilities that are allowed by this policy, if an array is returned then the individual ID's in the array represent the memberships that grant the ability.

## Other responses

- `401`: The API key is missing or otherwise invalid.
- `403`: The current API key is not authorized to perform this action.
- `429`: The request was rate limited.

## Changes

- **2026-09-05** `6287bce7caad`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/defaulr/apis/outline-api/changes/notifications.list/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) - [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) - [OpenAPI document](https://skmtc.dev/defaulr/apis/outline-api/revisions/5ddf01ffba84?raw)