> ## Documentation Index > Fetch the complete documentation index at: https://docs.nvisy.com/llms.txt > Use this file to discover all available pages before exploring further. # List notifications > Returns the authenticated account's notifications, most recent first. Read-only — use POST /notifications/read/ or POST /notifications/{notificationId}/read/ to mark them read. ## OpenAPI ````yaml /api-reference/openapi.json get /notifications/ openapi: 3.1.0 info: title: Nvisy API summary: Document processing and annotation platform description: >- Nvisy provides intelligent document processing, annotation, and analysis capabilities. This API enables document upload, OCR processing, embedding generation, and semantic search across your document collections. termsOfService: https://nvisy.com/legal/terms-of-service contact: name: Nvisy Support url: https://nvisy.com email: hello@nvisy.com license: name: Proprietary url: https://nvisy.com/license version: 0.1.0 servers: [] security: [] tags: - name: Accounts description: Account management and profile operations - name: Authentication description: Login, signup, and token management - name: Workspaces description: Workspace creation and management - name: Files description: File upload, download, and management - name: Members description: Workspace member management - name: Invites description: Workspace invitation handling - name: API Tokens description: API token management - name: Connections description: External provider connections - name: Pipelines description: Redaction pipeline configuration - name: Pipeline Runs description: Pipeline run execution and review - name: Policies description: Redaction policy configuration - name: Webhooks description: Webhook configuration - name: Notifications description: Account notification management - name: Health description: Service health checks paths: /notifications/: get: tags: - Notifications summary: List notifications description: >- Returns the authenticated account's notifications, most recent first. Read-only — use POST /notifications/read/ or POST /notifications/{notificationId}/read/ to mark them read. parameters: - in: query name: after description: |- Cursor pointing to the last item of the previous page. Obtain this from the `nextCursor` field in the response. schema: description: |- Cursor pointing to the last item of the previous page. Obtain this from the `nextCursor` field in the response. type: string style: form - in: query name: limit description: 'The maximum number of records to return (1-100, default: 20).' schema: description: 'The maximum number of records to return (1-100, default: 20).' type: integer format: uint32 maximum: 100 minimum: 1 style: form responses: '200': description: >- Generic paginated response wrapper. Provides a consistent structure for all paginated API responses with cursor-based pagination support. When `next_cursor` is present, there are more items to fetch. content: application/json: schema: $ref: '#/components/schemas/NotificationPage' '401': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: NotificationPage: description: |- Generic paginated response wrapper. Provides a consistent structure for all paginated API responses with cursor-based pagination support. When `next_cursor` is present, there are more items to fetch. type: object properties: items: description: Items in this page. type: array items: $ref: '#/components/schemas/Notification' nextCursor: description: Cursor to fetch the next page. Present only when more items exist. type: string total: description: Total count of items matching the query (if requested). type: integer format: int64 required: - items ErrorResponse: description: |- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. type: object properties: message: description: User-friendly error message safe for client display type: string name: description: The error name/type identifier type: string resource: description: The resource that the error relates to (optional, set by handler) type: string suggestion: description: Helpful suggestion for resolving the error (optional) type: string validation: description: Validation error details for field-specific errors type: array items: $ref: '#/components/schemas/ValidationErrorDetail' required: - name - message Notification: description: |- Response type for an account notification. The typed payload is nested under `payload`, so a notification is `{ id, payload: { notifyType, }, readAt, ... }`. type: object properties: createdAt: description: When the notification was created. type: string format: date-time expiresAt: description: When the notification expires. type: string format: date-time id: description: Unique notification identifier. type: string format: uuid payload: $ref: '#/components/schemas/NotificationPayload' description: >- The notification type and its typed params, absent when the stored params do not decode into their `notifyType`. readAt: description: When the notification was read; absent means unread. type: string format: date-time required: - id - createdAt ValidationErrorDetail: description: Validation error details for field-specific errors. type: object properties: code: description: Error code for the validation failure type: string field: description: Field name that failed validation type: string message: description: Human-readable error message type: string params: description: Additional parameters related to the validation error type: object additionalProperties: true required: - field - code - message NotificationPayload: description: >- The typed payload of a notification, tagged by `notifyType`. Each variant is one notification type carrying its own params struct. The `notifyType` values match [`NotificationEvent`], so the same key drives the member's per-event preferences. oneOf: - description: The account was invited to a workspace. type: object properties: notifyType: type: string const: member.invited allOf: - $ref: '#/components/schemas/MemberInvitedParams' required: - notifyType - description: A new member joined a workspace. type: object properties: notifyType: type: string const: member.joined allOf: - $ref: '#/components/schemas/MemberJoinedParams' required: - notifyType - description: A connection sync completed. type: object properties: notifyType: type: string const: connection.sync.completed allOf: - $ref: '#/components/schemas/ConnectionSyncCompletedParams' required: - notifyType - description: A connection sync failed. type: object properties: notifyType: type: string const: connection.sync.failed allOf: - $ref: '#/components/schemas/ConnectionSyncFailedParams' required: - notifyType - description: A pipeline run finished detection and is awaiting review. type: object properties: notifyType: type: string const: pipeline.run.analyzed allOf: - $ref: '#/components/schemas/PipelineRunAnalyzedParams' required: - notifyType - description: A pipeline run completed (redaction produced). type: object properties: notifyType: type: string const: pipeline.run.completed allOf: - $ref: '#/components/schemas/PipelineRunCompletedParams' required: - notifyType - description: A pipeline run failed. type: object properties: notifyType: type: string const: pipeline.run.failed allOf: - $ref: '#/components/schemas/PipelineRunFailedParams' required: - notifyType - description: A system-wide announcement. type: object properties: notifyType: type: string const: system.announcement allOf: - $ref: '#/components/schemas/SystemAnnouncementParams' required: - notifyType - description: A system report was generated. type: object properties: notifyType: type: string const: system.report allOf: - $ref: '#/components/schemas/SystemReportParams' required: - notifyType MemberInvitedParams: description: Params of a `member.invited` notification. type: object properties: invitedBy: description: Username of the account that sent the invite, if known. type: string workspaceSlug: description: Slug of the workspace the account was invited to. type: string required: - workspaceSlug MemberJoinedParams: description: Params of a `member.joined` notification. type: object properties: memberUsername: description: Username of the member that joined. type: string workspaceSlug: description: Slug of the workspace the member joined. type: string required: - workspaceSlug - memberUsername ConnectionSyncCompletedParams: description: Params of a `connection.sync.completed` notification. type: object properties: connectionId: description: Id of the connection that synced. type: string format: uuid recordsSynced: description: Number of records synced, if known. type: integer format: int64 required: - connectionId ConnectionSyncFailedParams: description: Params of a `connection.sync.failed` notification. type: object properties: connectionId: description: Id of the connection that failed to sync. type: string format: uuid error: description: Failure reason, if available. type: string required: - connectionId PipelineRunAnalyzedParams: description: Params of a `pipeline.run.analyzed` notification. type: object properties: inputFileName: description: Display name of the analyzed file, if known. type: string pipelineSlug: description: Slug of the owning pipeline. type: string runId: description: Id of the run. type: string format: uuid required: - runId - pipelineSlug PipelineRunCompletedParams: description: Params of a `pipeline.run.completed` notification. type: object properties: inputFileName: description: Display name of the analyzed file, if known. type: string pipelineSlug: description: Slug of the owning pipeline. type: string runId: description: Id of the run. type: string format: uuid required: - runId - pipelineSlug PipelineRunFailedParams: description: Params of a `pipeline.run.failed` notification. type: object properties: error: description: Failure reason, if available. type: string inputFileName: description: Display name of the analyzed file, if known. type: string pipelineSlug: description: Slug of the owning pipeline. type: string runId: description: Id of the run. type: string format: uuid required: - runId - pipelineSlug SystemAnnouncementParams: description: Params of a `system.announcement` notification. type: object properties: message: description: Announcement message key or body. type: string required: - message SystemReportParams: description: Params of a `system.report` notification. type: object properties: reportId: description: Id of the generated report, if any. type: string format: uuid ````