---
title: "List notification rules"
method: GET
path: "/api/v1/notificationRules"
tags: ["Notification Rules"]
---

# List notification rules

`GET /api/v1/notificationRules`

This endpoint allows you to list the notification rules in your organization.

This GET is a paginated API that uses the following parameters to request specific details:

- `size`: Supply an integer value between 10 and 1000, inclusive. The default value is 10.

- `page`: Supply an integer value. The default value is 0.

## Authentication

User authentication required: `true`

This endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.

## Tags

`Notification Rules`

## Rate limiting

60 requests/60 seconds

## Query parameters

- `page` integer
- `size` integer

## Response `200`

Successful response

- PublicApiListNotificationRulesResponse
  - `content` PublicApiNotificationRuleDTO[], required
    - `createdAt` string, date-time
    - `customization` NotificationCustomizationDTO
      - `message` string
      - `type` 'rich' | 'minimal', required
    - `filter` NotificationFilterDTO
      - `expression` NotificationFilterDTO — recursive
      - `expressions` NotificationFilterDTO[]
      - `field` NotificationFilterFieldDTO
        - `attributeName` string
        - `field` 'datasourceId' | 'datasourceLabel' | 'datasetId' | 'datasetLabel' | 'datasetOwnerId' | 'datasetTags' | 'checkId' | 'checkName' | 'checkOwnerId' | 'columnId' | 'metricType' | 'datasetResourceAttribute' | 'checkResourceAttribute', required
      - `type` 'equals' | 'contains' | 'in' | 'and' | 'or' | 'not', required
      - `value` string
      - `values` string[]
    - `id` string
    - `isDefault` boolean
    - `lastTriggeredAt` string, date-time
    - `name` string
    - `ownerId` string
    - `recipients` NotificationRecipientDTO[]
      - `customRoleId` string
      - `email` string
      - `integrationChannel` string
      - `integrationId` string
      - `role` 'datasetOwner' | 'monitorOwner'
      - `triggers` NotificationRecipientTriggerDTO[], required
        - `level` 'info' | 'warning' | 'critical' | 'not_evaluated'
        - `scanState` 'failed' | 'timedOut' | 'canceled' | 'completedWithErrors'
        - `type` 'testResultLevel' | 'scanState', required
      - `type` 'email' | 'user' | 'userGroup' | 'integration' | 'resourceRole' | 'customRole', required
      - `userGroupId` string
      - `userId` string
    - `ruleType` 'check' | 'monitor'
    - `status` 'active' | 'paused'
    - `updatedAt` string, date-time
  - `first` boolean, required
  - `last` boolean, required
  - `number` integer, required
  - `size` integer, required
  - `totalElements` integer, required
  - `totalPages` integer, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too many requests
- `500` — Internal server error

---

[API](https://skmtc.dev/soda/apis/soda-cloud-api-v4.md) · [All operations](https://skmtc.dev/soda/apis/soda-cloud-api-v4/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/soda/soda-cloud-api-v4/revisions/ce87192b6b72/schema)