> ## Documentation Index > Fetch the complete documentation index at: https://api-documentation.kare-app.fr/llms.txt > Use this file to discover all available pages before exploring further. # List the caller's notification inbox ## OpenAPI ````yaml /api/rs/openapi.json get /rs/notifications/v1/ openapi: 3.0.3 info: title: KARE API description: Backend API for the KARE platform version: dev servers: - url: http://localhost:3000 description: Local dev security: [] tags: - name: better-auth description: >- Better Auth's own endpoints (sign-in, session, MFA, password) - generated from the audience's live config via `generateOpenAPISchema()`, not hand-written. paths: /rs/notifications/v1/: get: tags: - notifications summary: List the caller's notification inbox operationId: listNotificationsRSV1 parameters: - schema: default: 1 type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 in: query name: page required: false - schema: default: 50 type: integer minimum: 0 exclusiveMinimum: true maximum: 1000 in: query name: pageSize required: false - schema: example: true anyOf: - type: boolean in: query name: countOnly required: false description: >- When true, answers `totalCount` with an empty `data`: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter. - schema: type: array items: type: string enum: - actions-info description: >- Extend options (JSON-encoded array, e.g. `?extend=["category"]`): - "actions-info": Adds `actions` { canBeMarkedRead, canBeMarkedUnread, canBeDeleted } per row. in: query name: extend required: false - schema: type: array items: type: object properties: field: type: string enum: - createdAt - updatedAt description: >- OrderBy options (JSON-encoded array, e.g. `?orderBy=[{"field":"name","direction":"asc"}]`): - "createdAt": Order by creation date. - "updatedAt": Order by last update date. direction: type: string enum: - asc - desc description: Sort direction example: asc required: - field - direction in: query name: orderBy required: false - schema: type: array items: type: string example: - alert - reminder in: query name: whereSeverity required: false description: Filter by one or more severities (alert, reminder, info). - schema: type: string maxLength: 200 example: lobby in: query name: whereBefore required: false description: >- Keyset cursor "|", taken from the last row received. Answers the rows strictly older than it, in the default newest-first order. Unlike page/pageSize it does not shift when a notification arrives between two calls. - schema: anyOf: - type: boolean - type: string example: true in: query name: whereUnread required: false description: true = unread only, false = read only, omitted = both. - schema: anyOf: - type: boolean - type: string example: true in: query name: wherePinned required: false description: true = pinned only, false = unpinned only, omitted = both. - schema: anyOf: - type: boolean - type: string example: true in: query name: whereActionRequired required: false description: >- true = only types the caller must act on, false = only types that are not, omitted = both. responses: '200': description: Default Response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ type: type: string enum: - deadline_reminder - deadline_overdue - commission_reminder - inbox_report_received - conversation_message_received - intervention_started - intervention_signed - intervention_planned - intervention_overdue - user_action severity: type: string enum: - alert - reminder - info expectation: type: string enum: - required - suggested - none action: nullable: true type: string enum: - plan - reschedule - verify - process - prepare title: type: string minLength: 1 maxLength: 200 body: nullable: true type: string maxLength: 2000 payload: nullable: true type: object additionalProperties: {} channels: type: array items: type: string enum: - in_app - email - sms subjectType: nullable: true type: string enum: - Anomaly - AnomalyIntervention - BoUser - Building - BuildingWork - Comment - Commission - Compliance - Contact - Contract - ContractDocument - Conversation - Diploma - Document - EmailSenderRule - Equipment - EquipmentSpecification - Folder - FormSubmission - FormTemplate - Identity - InboxItem - InboxMail - Intervention - InterventionLink - Label - LibraryAnomaly - LibraryEquipmentSpecification - LibraryLabel - LibraryRole - LibraryRule - LibraryTechnicalInstallation - Logbook - Notification - NotificationPreference - Organization - Plan - PlanItem - Project - ProjectFolder - Provider - ProviderAccess - PrUser - QrCode - QrCodeGeneration - Report - ReportAnalysis - Responsibility - Role - Routine - Rule - SelectionPerimeter - TagType - TechnicalInstallation - Unit - User subjectId: nullable: true type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ subjectLabel: nullable: true type: string minLength: 1 maxLength: 200 readAt: nullable: true type: string format: date-time pinnedAt: nullable: true type: string format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time actions: type: object properties: canBeMarkedRead: type: boolean canBeMarkedUnread: type: boolean canBePinned: type: boolean canBeUnpinned: type: boolean canBeDeleted: type: boolean required: - canBeMarkedRead - canBeMarkedUnread - canBePinned - canBeUnpinned - canBeDeleted additionalProperties: false required: - id - type - severity - expectation - action - title - body - payload - channels - subjectType - subjectId - subjectLabel - readAt - pinnedAt - createdAt - updatedAt additionalProperties: false totalCount: type: integer minimum: 0 maximum: 9007199254740991 pagination: type: object properties: page: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 pageSize: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 totalPages: type: integer minimum: 0 maximum: 9007199254740991 required: - page - pageSize - totalPages additionalProperties: false required: - data - totalCount - pagination additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false ````