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

# List Notifications

> Lists inbox notifications.



## OpenAPI

````yaml /api-reference/ops/openapi.json get /api/v1/ops/notifications
openapi: 3.0.0
info:
  title: DEVMOB OPS API
  description: DEVMOB API
  version: '1.0'
  contact: {}
servers: []
security: []
tags:
  - name: Auth
    description: Authentication and token lifecycle
  - name: Bank Account
    description: Bank accounts
  - name: Benefit
    description: Benefit categories and usage history
  - name: Benefit Program
    description: Fare benefit programs
  - name: Benefit Request
    description: Fare benefit requests and documents
  - name: Credit Grant
    description: Company granted credits
  - name: Driver
    description: Company drivers
  - name: Employee
    description: Company employees
  - name: Employee Session
    description: Employee sessions
  - name: Export
    description: Export resources
  - name: Export Job
    description: Immediate export jobs
  - name: Export Schedule
    description: Scheduled exports
  - name: Invite
    description: Member invitations
  - name: Notification
    description: OPS inbox notifications
  - name: Offering
    description: Trip offerings and seat maps
  - name: Order
    description: Orders
  - name: Organization
    description: Organization profile
  - name: Organization Address
    description: Organization address
  - name: OTP
    description: One-time password flows
  - name: Payment
    description: Payments
  - name: Permission
    description: Permissions
  - name: Point
    description: Point lookup
  - name: Profile
    description: Authenticated OPS profile
  - name: Promotion
    description: Promotions
  - name: Promotion Rule
    description: Promotion rules
  - name: Receivable
    description: Receivables
  - name: Report
    description: Operational reports
  - name: Role
    description: Roles
  - name: Route
    description: Routes
  - name: Route Approval
    description: Route approvals
  - name: Routing
    description: Routing helpers
  - name: Storage
    description: Storage uploads
  - name: Support
    description: Support cases
  - name: Transfer
    description: Transfers
  - name: Trip
    description: Trips
  - name: Trip Event
    description: Trip operational events
  - name: Trip Schedule
    description: Recurring trip schedules
  - name: Trip Tracking
    description: Trip GPS tracking
  - name: Vehicle
    description: Vehicles and seats
paths:
  /api/v1/ops/notifications:
    get:
      tags:
        - Notification
      summary: List Notifications
      description: Lists inbox notifications.
      operationId: listOpsNotifications
      parameters:
        - name: limit
          required: false
          in: query
          schema:
            default: 10
            description: Items per page
            example: 10
            type: number
            minimum: 1
            maximum: 100
        - name: page
          required: false
          in: query
          schema:
            default: 1
            description: Page number
            example: 1
            type: number
            minimum: 1
        - name: status
          required: false
          in: query
          schema:
            type: string
            enum:
              - UNREAD
              - READ
              - ARCHIVED
            description: Recipient status
            example: UNREAD
        - name: type
          required: false
          in: query
          schema:
            type: string
            enum:
              - SUPPORT_CASE_CREATED
              - SUPPORT_CASE_MESSAGE_CREATED
              - SUPPORT_CASE_ASSIGNED
              - SUPPORT_CASE_STATUS_CHANGED
              - ROUTE_APPROVAL_REQUESTED
              - ROUTE_APPROVED
              - ROUTE_REJECTED
              - TRIP_STATUS_CHANGED
              - TRIP_EVENT_RECORDED
              - PAYMENT_CONFIRMED
              - PAYMENT_FAILED
              - TRANSFER_PROCESSED
              - TRANSFER_FAILED
              - ORDER_CONFIRMED
              - ORDER_CANCELLED
              - TICKET_CANCELLED
              - BENEFIT_REQUEST_APPROVED
              - BENEFIT_REQUEST_REJECTED
              - EXPORT_COMPLETED
              - EXPORT_FAILED
            description: Notification type
            example: ROUTE_APPROVAL_REQUESTED
        - name: priority
          required: false
          in: query
          schema:
            type: string
            enum:
              - LOW
              - NORMAL
              - HIGH
              - URGENT
            description: Notification priority
            example: NORMAL
        - name: resourceDomain
          required: false
          in: query
          schema:
            type: string
            description: Related resource domain
            example: OPERATIONS
        - name: resource
          required: false
          in: query
          schema:
            type: string
            description: Related resource name
            example: ROUTE_APPROVAL
        - name: createdAt
          required: false
          in: query
          schema:
            type: string
            description: Created date range
            example: '>=2026-07-01;<=2026-07-31'
        - name: sortBy
          required: false
          in: query
          schema:
            default: createdAt
            description: Field to sort by
            example: createdAt
            type: string
            enum:
              - createdAt
              - readAt
              - priority
        - name: sortOrder
          required: false
          in: query
          schema:
            default: desc
            description: Sort order
            example: desc
            type: string
            enum:
              - asc
              - desc
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection (e.g.
            `id,name,user.email,trips.route.id`). Unknown fields are silently
            dropped.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotificationRecipient'
                  meta:
                    $ref: '#/components/schemas/PageMeta'
                required:
                  - data
                  - meta
        '400':
          content:
            application/json:
              example:
                errors:
                  - message: required
                    path: name
                message: Bad Request Error
                statusCode: 400
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 400
                    type: number
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                        path:
                          type: string
                      required:
                        - message
                        - path
                      type: object
                    type: array
                required:
                  - message
                  - statusCode
                type: object
          description: Bad Request Error
        '401':
          content:
            application/json:
              example:
                message: Missing or invalid access token
                statusCode: 401
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 401
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                message: Insufficient permissions
                statusCode: 403
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 403
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Forbidden
        '500':
          content:
            application/json:
              example:
                message: Internal Server Error
                statusCode: 500
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 500
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Internal Server Error
      security:
        - bearer: []
        - bearer: []
components:
  schemas:
    NotificationRecipient:
      type: object
      properties:
        notificationRecipientId:
          type: string
          format: uuid
          description: Identificador único
        notificationId:
          type: string
          format: uuid
          description: Notificação recebida
        recipientUserId:
          type: string
          format: uuid
          description: Usuário destinatário
        deliveredAt:
          type: string
          format: date-time
          nullable: true
          description: Data em que foi entregue via realtime ou inbox
        readAt:
          type: string
          format: date-time
          nullable: true
          description: Data em que foi marcada como lida
        archivedAt:
          type: string
          format: date-time
          nullable: true
          description: Data em que foi arquivada
        status:
          type: string
          enum:
            - UNREAD
            - READ
            - ARCHIVED
          description: Estado da notificação para o destinatário
        createdBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que criou o registro, quando aplicável
        createdAt:
          type: string
          format: date-time
          description: Data de criação
        updatedBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que fez a última atualização, quando aplicável
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização
        deletedBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que removeu o registro, quando aplicável
        deletedAt:
          type: string
          format: date-time
          nullable: true
          description: Data de remoção lógica
      required:
        - notificationRecipientId
        - notificationId
        - recipientUserId
        - deliveredAt
        - readAt
        - archivedAt
        - status
        - createdBy
        - createdAt
        - updatedBy
        - updatedAt
        - deletedBy
        - deletedAt
      description: Estado individual de uma notificação para um usuário destinatário
    PageMeta:
      type: object
      properties:
        page:
          type: integer
          description: Current page number
          example: 1
        limit:
          type: integer
          description: Items per page
          example: 20
        total:
          type: integer
          description: Total number of items
          example: 125
        totalPages:
          type: integer
          description: Total number of pages
          example: 7
      required:
        - page
        - limit
        - total
        - totalPages
      description: Pagination metadata
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````