> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List your notifications

> Your notifications, newest first. Pass `next_cursor` back for more.



## OpenAPI

````yaml get /api/notifications
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/notifications:
    get:
      tags:
        - Notifications
      summary: List your notifications
      description: Your notifications, newest first. Pass `next_cursor` back for more.
      operationId: list_notifications_api_notifications_get
      parameters:
        - name: view
          in: query
          required: false
          schema:
            enum:
              - all
              - action
              - updates
              - unread
              - archived
            type: string
            default: all
            title: View
        - name: category
          in: query
          required: false
          schema:
            anyOf:
              - enum:
                  - reviews
                  - runs
                  - data
                  - documents
                  - security
                type: string
              - type: 'null'
            title: Category
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 128
              - type: 'null'
            title: Cursor
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 30
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPage'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Not a person's sign-in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    NotificationPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/NotificationItem'
          type: array
          title: Items
          description: The notifications.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Pass as `cursor` for the next page; none at the end.
      type: object
      required:
        - items
      title: NotificationPage
      description: A page of the inbox, newest first.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    NotificationItem:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: The notification's id.
        topic:
          type: string
          title: Topic
          description: What kind of thing happened, e.g. review_waiting.
        category:
          type: string
          enum:
            - reviews
            - runs
            - data
            - documents
            - security
          title: Category
          description: The inbox category it is filed under.
        kind:
          type: string
          title: Kind
          description: The precise event, e.g. registry.submitted.
        title:
          type: string
          title: Title
          description: One line saying what happened.
        body:
          type: string
          title: Body
          description: A short second line.
          default: ''
        link:
          anyOf:
            - type: string
            - type: 'null'
          title: Link
          description: A portal path to open, such as /registry/review.
        actor:
          anyOf:
            - type: string
            - type: 'null'
          title: Actor
          description: Who caused it, when a person did.
        requires_action:
          type: boolean
          title: Requires Action
          description: True when it waits on the caller (a review, an invitation).
        resolved:
          type: boolean
          title: Resolved
          description: True once what it asked for is done, by anyone it was sent to.
        read:
          type: boolean
          title: Read
          description: Whether the caller has read it.
        archived:
          type: boolean
          title: Archived
          description: Whether the caller archived it.
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
          description: Why the caller got it, e.g. a role they hold.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When it happened (UTC).
      type: object
      required:
        - id
        - topic
        - category
        - kind
        - title
        - requires_action
        - resolved
        - read
        - archived
        - created_at
      title: NotificationItem
      description: One notification in the caller's inbox.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.