Skip to main content
GET
/
v1
/
teams
/
{team_id}
/
notifications
List Notification Configs
curl --request GET \
  --url https://api.dataraven.io/v1/teams/{team_id}/notifications \
  --header 'Authorization: Bearer <token>'
{
  "notifications": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "event_type": "<string>",
      "event_filters": {},
      "message_template": "<string>",
      "is_enabled": true,
      "apprise_vault_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
team_id
string<uuid>
required

Query Parameters

​
q
string | null

Search by name (case-insensitive partial match)

​
event_type
string | null

Filter by event type

​
is_enabled
boolean | null

Filter by enabled status

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
limit
integer
default:50

Items per page

Required range: 1 <= x <= 100
​
sort_by
enum<string> | null

Field to sort by: name, event_type, created_at

Available options:
name,
event_type,
created_at
​
sort_order
enum<string> | null

Sort order: asc or desc (default: desc) Sort order for list endpoints.

Available options:
asc,
desc

Response

Successful Response

Schema for list endpoint response

​
notifications
NotificationConfigResponse · object[]
required
​
pagination
PaginationResponse · object
required

Pagination metadata in responses.