v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Notifications

List notification settings

List notification settings.

get/notification_settings

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Consolidated filter parameter (deepObject style). Originally: filter[associated_record_type][eq], filter[channel_type_id][eq], filter[notification_profile_id][eq], filter[notification_channel][eq], filter[notification_event_condition_id][eq], filter[status][eq]

{
  "associated_record_type": {
    "eq": "phone_number"
  },
  "channel_type_id": {
    "eq": "webhook"
  },
  "notification_channel": {
    "eq": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
  },
  "notification_event_condition_id": {
    "eq": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
  },
  "notification_profile_id": {
    "eq": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
  },
  "status": {
    "eq": "enable-received"
  }
}

Response

Returns a list of notification settings.

Example response

{
  "data": [
    {
      "associated_record_type": "phone_number",
      "associated_record_type_value": "+13125550000",
      "created_at": "2019-10-15T10:07:15.527Z",
      "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
      "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
      "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "parameters": [
        {
          "name": "phone_number",
          "value": "+13125550000"
        }
      ],
      "status": "enable-received",
      "updated_at": "2019-10-15T10:07:15.527Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}