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.
The order direction.
orderBy'id' | 'type' | 'createdAt' | 'updatedAt'
Order by options for notification channels.
The order by field.
Response
The request has succeeded.
Example response
{
"items": [
{
"annotations": {
"externalId": "019142cc-a016-796a-8113-1a942fecd26d"
},
"channels": [
{
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
}
],
"createdAt": "2024-01-01T01:01:01.001Z",
"deletedAt": "2024-01-01T01:01:01.001Z",
"disabled": true,
"features": [
{
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"key": "gpt4_tokens"
}
],
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"metadata": {
"externalId": "019142cc-a016-796a-8113-1a942fecd26d"
},
"name": "Balance threshold reached",
"thresholds": [
{
"value": 100
}
],
"updatedAt": "2024-01-01T01:01:01.001Z"
}
],
"page": 1,
"pageSize": 100,
"totalCount": 500
}Changes
No recorded changes to this endpoint across all 1 revision of this API.