Sign in
Notifications

List notification channels

Returns a paginated list of your notification channels, the destinations that receive notifications.

get/notification_channels

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 channels.

Example response

{
  "data": [
    {
      "channel_destination": "+13125550000",
      "created_at": "2019-10-15T10:07:15.527Z",
      "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "updated_at": "2019-10-15T10:07:15.527Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Changes

Changed in 2 of the 61 revisions of this API.9

  • 1571b0380bd73See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 500

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379946See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 500

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 400

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 500

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog