v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB

Notifications

List notification rules

List all notification rules.

get/api/v1/notification/rules

Query parameters

includeDeletedboolean

Include deleted notification rules in response.

Usage: ?includeDeleted=true

includeDisabledboolean

Include disabled notification rules in response.

Usage: ?includeDisabled=false

featurestring[]

Filtering by multiple feature ids/keys.

Usage: ?feature=feature-1&feature=feature-2

channelstring[]

Filtering by multiple notifiaction channel ids.

Usage: ?channel=01ARZ3NDEKTSV4RRFFQ69G5FAV&channel=01J8J2Y5X4NNGQS32CF81W95E3

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

order'ASC' | 'DESC'

The order direction.

orderBy'id' | 'type' | 'createdAt' | 'updatedAt'

Order by options for notification channels.

The order by field.

Response

The request has succeeded.

totalCountinteger required

The total number of items.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

Example response

{
  "totalCount": 500,
  "page": 1,
  "pageSize": 100,
  "items": [
    {
      "createdAt": "2024-01-01T01:01:01.001Z",
      "updatedAt": "2024-01-01T01:01:01.001Z",
      "deletedAt": "2024-01-01T01:01:01.001Z",
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "name": "Balance threshold reached",
      "disabled": true,
      "channels": [
        {
          "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
        }
      ],
      "annotations": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      },
      "metadata": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      },
      "thresholds": [
        {
          "value": 100
        }
      ],
      "features": [
        {
          "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
          "key": "gpt4_tokens"
        }
      ]
    }
  ]
}