medusa-store/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml

get:
  operationId: GetNotifications
  summary: List Notifications
  description: >-
    Retrieve a list of notifications. The notifications can be filtered by
    fields such as `id`. The notifications can also be sorted or paginated.
  x-authenticated: true
  parameters:
    - name: fields
      in: query
      description: >-
        Comma-separated fields that should be included in the returned data. if
        a field is prefixed with `+` it will be added to the default fields,
        using `-` will remove it from the default fields. without prefix it will
        replace the entire default fields.
      required: false
      schema:
        type: string
        title: fields
        description: >-
          Comma-separated fields that should be included in the returned data.
          if a field is prefixed with `+` it will be added to the default
          fields, using `-` will remove it from the default fields. without
          prefix it will replace the entire default fields.
        externalDocs:
          url: '#select-fields-and-relations'
    - name: offset
      in: query
      description: The number of items to skip when retrieving a list.
      required: false
      schema:
        type: number
        title: offset
        description: The number of items to skip when retrieving a list.
        externalDocs:
          url: '#pagination'
    - name: limit
      in: query
      description: Limit the number of items returned in the list.
      required: false
      schema:
        type: number
        title: limit
        description: Limit the number of items returned in the list.
        externalDocs:
          url: '#pagination'
    - name: order
      in: query
      description: >-
        The field to sort the data by. By default, the sort order is ascending.
        To change the order to descending, prefix the field name with `-`.
      required: false
      schema:
        type: string
        title: order
        description: >-
          The field to sort the data by. By default, the sort order is
          ascending. To change the order to descending, prefix the field name
          with `-`.
    - name: q
      in: query
      description: Search term to apply on the notification's searchable properties.
      required: false
      schema:
        type: string
        title: q
        description: Search term to apply on the notification's searchable properties.
    - name: id
      in: query
      required: false
      schema:
        oneOf:
          - type: string
            title: id
            description: Filter by a notification ID.
          - type: array
            description: Filter by notification IDs.
            items:
              type: string
              title: id
              description: A notification ID.
    - name: channel
      in: query
      required: false
      schema:
        oneOf:
          - type: string
            title: channel
            description: Filter by a notification channel.
            example: email
          - type: array
            description: Filter by notification channels.
            items:
              type: string
              title: channel
              description: A notification channel.
              example: email
    - name: $and
      in: query
      required: false
      schema:
        type: array
        description: >-
          Join query parameters with an AND condition. Each object's content is
          the same type as the expected query parameters.
        items:
          type: object
        title: $and
    - name: $or
      in: query
      required: false
      schema:
        type: array
        description: >-
          Join query parameters with an OR condition. Each object's content is
          the same type as the expected query parameters.
        items:
          type: object
        title: $or
    - name: with_deleted
      in: query
      description: Whether to include deleted records in the result.
      required: false
      schema:
        type: boolean
        title: with_deleted
        description: Whether to include deleted records in the result.
  security:
    - api_token: []
    - cookie_auth: []
    - jwt_token: []
  x-codeSamples:
    - lang: JavaScript
      label: JS SDK
      source:
        $ref: ../code_samples/JavaScript/admin_notifications/get.js
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/admin_notifications/get.sh
  tags:
    - Notifications
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: ../components/schemas/AdminNotificationListResponse.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml