get:
  operationId: GetNotifications
  summary: List Notifications
  description: >-
    Retrieve a list of notifications. The notifications can be filtered by
    fields such as `event_name` or `resource_type`. The notifications can also
    be paginated.
  x-authenticated: true
  parameters:
    - in: query
      name: offset
      description: >-
        The number of inventory items to skip when retrieving the inventory
        items.
      schema:
        type: integer
        default: 0
    - in: query
      name: limit
      description: Limit the number of notifications returned.
      schema:
        type: integer
        default: 50
    - in: query
      name: fields
      description: >-
        Comma-separated fields that should be included in each returned
        notification.
      schema:
        type: string
    - in: query
      name: expand
      description: >-
        Comma-separated relations that should be expanded in each returned
        notification.
      schema:
        type: string
    - in: query
      name: event_name
      description: >-
        Filter by the name of the event that triggered sending this
        notification.
      schema:
        type: string
    - in: query
      name: resource_type
      description: Filter by the resource type.
      schema:
        type: string
    - in: query
      name: resource_id
      description: Filter by the resource ID.
      schema:
        type: string
    - in: query
      name: to
      description: >-
        Filter by the address that the Notification was sent to. This will
        usually be an email address, but it can also represent other addresses
        such as a chat bot user id.
      schema:
        type: string
    - in: query
      name: include_resends
      description: >-
        A boolean indicating whether the result set should include resent
        notifications or not
      schema:
        type: string
  x-codegen:
    method: list
    queryParams: AdminGetNotificationsParams
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/admin_notifications/get.js
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/admin_notifications/get.sh
  security:
    - api_token: []
    - cookie_auth: []
    - jwt_token: []
  tags:
    - Notifications
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: ../components/schemas/AdminNotificationsListRes.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