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

# List Notifications

> Everything worth interrupting somebody for.

**Who may call it:** any role. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json get /v1/notifications
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/notifications:
    get:
      tags:
        - Notifications
      summary: List Notifications
      description: >-
        Everything worth interrupting somebody for.


        **Who may call it:** any role. A workspace API key is refused here: this
        is an act that belongs to a named person.
      operationId: list_notifications_v1_notifications_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsOut'
      security:
        - bearerToken: []
components:
  schemas:
    NotificationsOut:
      properties:
        notifications:
          items:
            $ref: '#/components/schemas/NotificationOut'
          type: array
          title: Notifications
          default: []
        unacknowledged:
          type: integer
          title: Unacknowledged
          default: 0
        scope:
          type: string
          title: Scope
          default: ''
      type: object
      title: NotificationsOut
    NotificationOut:
      properties:
        key:
          type: string
          title: Key
        kind:
          type: string
          title: Kind
        title:
          type: string
          title: Title
        detail:
          type: string
          title: Detail
        subject_kind:
          type: string
          title: Subject Kind
        subject_id:
          type: string
          title: Subject Id
        urgency:
          type: string
          title: Urgency
        at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: At
        acknowledged_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Acknowledged By
        acknowledged_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Acknowledged At
      type: object
      required:
        - key
        - kind
        - title
        - detail
        - subject_kind
        - subject_id
        - urgency
      title: NotificationOut
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

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