Sign in
Notifications

List notification settings

Returns a paginated list of your notification settings, which map notification event types to profiles and channels.

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_profile_id": {
    "eq": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
  },
  "notification_channel": {
    "eq": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
  },
  "notification_event_condition_id": {
    "eq": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
  },
  "status": {
    "eq": "enable-received"
  }
}

Response

Returns a list of notification settings.

Example response

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

Changes

Changed in 3 of the 99 revisions of this API.15

  • a6a61a29ecdd6See the full diff
    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

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

  • 1571b0380bd73See the full diff
    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      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 // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      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

Of the 99 revisions, 1 has no diff computed.