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

# Get the authenticated user's chat and system notifications as one feed



## OpenAPI

````yaml get /v1/notifications
openapi: 3.1.0
info:
  title: Flextell API
  version: 0.0.1
  description: >-
    Flextell REST API referansı. Kimlik doğrulama, scope ve istek kuralları için
    API sekmesindeki rehberlere bakın.
servers:
  - url: https://app.flextell.ai/api
    description: Üretim
security:
  - oauth2: []
  - bearer: []
paths:
  /v1/notifications:
    get:
      tags:
        - Notification
      summary: Get the authenticated user's chat and system notifications as one feed
      operationId: notification.index
      parameters:
        - name: source
          in: query
          description: Filter by source (chat, system).
          schema:
            anyOf:
              - $ref: '#/components/schemas/NotificationSource'
              - type: 'null'
        - name: unread
          in: query
          description: Return only unread notifications.
          schema:
            type:
              - boolean
              - 'null'
        - name: created_at_from
          in: query
          description: Filter notifications created on or after this date.
          schema:
            type:
              - string
              - 'null'
            format: date-time
        - name: created_at_to
          in: query
          description: Filter notifications created on or before this date.
          schema:
            type:
              - string
              - 'null'
            format: date-time
        - name: per_page
          in: query
          description: The number of items per page.
          schema:
            type:
              - integer
              - 'null'
            minimum: 1
            maximum: 100
        - name: page
          in: query
          description: The page number.
          schema:
            type:
              - integer
              - 'null'
            minimum: 1
        - name: X-Tenant
          in: header
          required: true
          description: >-
            Tenant identifier. Send the Tenant ID in the `X-Tenant` header to
            scope API requests to a specific tenant.
          schema:
            type: number
      responses:
        '200':
          description: Paginated set of `NotificationResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotificationResource'
                  links:
                    type: object
                    properties:
                      first:
                        type:
                          - string
                          - 'null'
                      last:
                        type:
                          - string
                          - 'null'
                      prev:
                        type:
                          - string
                          - 'null'
                      next:
                        type:
                          - string
                          - 'null'
                    required:
                      - first
                      - last
                      - prev
                      - next
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        minimum: 1
                      from:
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      last_page:
                        type: integer
                        minimum: 1
                      links:
                        type: array
                        description: Generated paginator links.
                        items:
                          type: object
                          properties:
                            url:
                              type:
                                - string
                                - 'null'
                            label:
                              type: string
                            active:
                              type: boolean
                          required:
                            - url
                            - label
                            - active
                      path:
                        type:
                          - string
                          - 'null'
                        description: Base path for paginator generated URLs.
                      per_page:
                        type: integer
                        description: Number of items shown per page.
                        minimum: 0
                      to:
                        type:
                          - integer
                          - 'null'
                        description: Number of the last item in the slice.
                        minimum: 1
                      total:
                        type: integer
                        description: Total number of items being paginated.
                        minimum: 0
                    required:
                      - current_page
                      - from
                      - last_page
                      - links
                      - path
                      - per_page
                      - to
                      - total
                required:
                  - data
                  - links
                  - meta
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  schemas:
    NotificationSource:
      type: string
      enum:
        - chat
        - system
      title: NotificationSource
    NotificationResource:
      type: object
      properties:
        id:
          type: string
          description: Chat notifications carry a numeric id, system notifications a UUID.
        source:
          type: string
          enum:
            - chat
            - system
        type:
          type:
            - string
            - 'null'
        category:
          type:
            - string
            - 'null'
        level:
          type:
            - string
            - 'null'
          enum:
            - info
            - success
            - warning
            - danger
            - null
        title:
          type:
            - string
            - 'null'
        body:
          type:
            - string
            - 'null'
        resource:
          type:
            - string
            - 'null'
          description: >-
            The kind of record to open when the notification is clicked (e.g.
            appointment, conversation).
        resource_id:
          type:
            - integer
            - 'null'
        parent_resource:
          type:
            - string
            - 'null'
          description: >-
            The record the target is nested under, when it cannot be opened on
            its own (e.g. a task's lead, or its patient).
        parent_resource_id:
          type:
            - integer
            - 'null'
        download_url:
          type:
            - string
            - 'null'
          description: Temporary download link for export notifications.
        avatar_url:
          type:
            - string
            - 'null'
          description: >-
            Photo of the patient the notification is about; null when there is
            no patient or no photo.
        read_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - id
        - source
        - type
        - category
        - level
        - title
        - body
        - resource
        - resource_id
        - parent_resource
        - parent_resource_id
        - download_url
        - avatar_url
        - read_at
        - created_at
      title: NotificationResource
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://dev.flextell.ai/oauth/authorize
          tokenUrl: https://dev.flextell.ai/oauth/token
          scopes:
            '*': all
    bearer:
      type: http
      scheme: bearer

````

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