> ## Documentation Index > Fetch the complete documentation index at: https://docs.visorfinance.app/llms.txt > Use this file to discover all available pages before exploring further. # List notifications > Returns one page of the user's inbox, newest first. Requires the `pfm:read` scope. Pass `next_cursor` as `after` to read the next page; it is `null` on the last page. Notifications the user cleared do not appear. ## OpenAPI ````yaml /openapi.json get /v1/notifications openapi: 3.0.3 info: description: >- Personal REST API for Visor Pro and Premium users. Authenticate with a personal API token created in Visor Settings, sent as `Authorization: Bearer visor_pat_...`, or with an OAuth access token from the Visor CLI browser login. title: Visor Personal API version: 1.0.0 servers: - url: https://api.visorfinance.app variables: {} security: - personal_api_token: [] - visor_cli_oauth: - pfm:read tags: [] paths: /v1/notifications: get: tags: - Notifications summary: List notifications description: >- Returns one page of the user's inbox, newest first. Requires the `pfm:read` scope. Pass `next_cursor` as `after` to read the next page; it is `null` on the last page. Notifications the user cleared do not appear. operationId: VisorWeb.Api.V1.NotificationController.index parameters: - description: >- `true` for only unread notifications, `false` for only read ones. Omit it for both. in: query name: unread required: false schema: type: boolean - description: Notifications per page, 1 to 50. Defaults to 30. in: query name: limit required: false schema: default: 30 maximum: 50 minimum: 1 type: integer - description: The `next_cursor` of the previous page. Omit it for the first page. in: query name: after required: false schema: type: string responses: '200': content: application/json: example: data: - body: Internet vence amanhã, R$ 119,90. created_at: '2026-10-01T15:31:02Z' id: 2b7e9a4c-6d1f-4c3a-8e5b-9f0a1b2c3d4e read: false read_at: null space_id: 6f1c2a9e-1d7b-4c55-9a3e-2b8f0c4d5e61 title: Conta vence amanhã topic: bill_reminder next_cursor: MjAyNi0xMC0wMVQxNTozMTowMlp8OWMxZQ schema: $ref: '#/components/schemas/NotificationListResponse' description: One page of notifications headers: x-ratelimit-limit: description: Requests allowed for this token per minute schema: example: 60 type: integer style: simple x-ratelimit-remaining: description: Requests left for this token in the current minute schema: example: 59 type: integer style: simple x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '400': content: application/json: example: errors: - code: BAD_REQUEST details: parameter: include_hidden message: The request is malformed. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: A query parameter has an invalid value headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '401': content: application/json: example: errors: - code: INVALID_TOKEN details: {} message: The personal API token is not valid. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Missing, invalid, expired, or revoked token headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '403': content: application/json: example: errors: - code: INSUFFICIENT_SCOPE details: required_scope: pfm:read message: The personal API token does not grant this operation. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Pro or Premium plan required, or insufficient scope headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '406': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: The client does not accept JSON headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '429': content: application/json: example: errors: - code: RATE_LIMITED details: retry_after_seconds: 42 message: >- Too many requests. Retry after the number of seconds in Retry-After. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Rate limit exceeded headers: retry-after: description: Seconds until the current window ends schema: example: 42 type: integer style: simple x-ratelimit-limit: description: Requests allowed for this token per minute schema: example: 60 type: integer style: simple x-ratelimit-remaining: description: Requests left for this token in the current minute schema: example: 59 type: integer style: simple x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple callbacks: {} components: schemas: NotificationListResponse: additionalProperties: false properties: data: items: $ref: '#/components/schemas/Notification' type: array next_cursor: description: Pass as `after` to read the next page; null on the last page nullable: true type: string required: - data - next_cursor title: NotificationListResponse type: object ErrorResponse: additionalProperties: false properties: errors: items: $ref: '#/components/schemas/Error' minItems: 1 type: array required: - errors title: ErrorResponse type: object Notification: additionalProperties: false properties: body: description: The text the inbox shows, in the user's language type: string created_at: format: date-time type: string id: format: uuid type: string read: type: boolean read_at: format: date-time nullable: true type: string space_id: description: >- The space the notification is about; null for a notification about the whole account format: uuid nullable: true type: string title: description: The title the inbox shows, in the user's language type: string topic: description: >- A stable code for the kind of notification, such as `bill_reminder` or `weekly_summary` example: bill_reminder type: string required: - id - topic - title - body - read - read_at - space_id - created_at title: Notification type: object Error: additionalProperties: false properties: code: description: Stable machine-readable code example: INVALID_TOKEN type: string details: additionalProperties: true description: Code-specific context type: object message: description: English text for developers type: string request_id: description: The x-request-id response header of the request nullable: true type: string required: - code - message - details - request_id title: Error type: object securitySchemes: personal_api_token: bearerFormat: visor_pat__ description: Personal API token created in Visor Settings scheme: bearer type: http visor_cli_oauth: description: >- OAuth 2.0 access token of the Visor CLI browser login (authorization code with PKCE). Only the first-party Visor CLI client can use it on this API. flows: authorizationCode: authorizationUrl: https://dashboard.visorfinance.app/oauth/authorize refreshUrl: https://dashboard.visorfinance.app/oauth/token scopes: pfm:read: Read financial data pfm:transactions:write: Create, edit, and delete transactions pix:payments:write: Start Pix payments that you confirm with biometrics at your bank tokenUrl: https://dashboard.visorfinance.app/oauth/token type: oauth2 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.