List notification settings

GET 
/notification_settings

List notification settings.

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

filter[notification_profile_id][eq] string

Filter by the id of a notification profile

filter[notification_channel][eq] string

Filter by the id of a notification channel

filter[notification_event_condition_id][eq] string

Filter by the id of a notification channel

filter[associated_record_type][eq] string

Possible values: [account, phone_number]

Filter by the associated record type

filter[status][eq] string

Possible values: [enabled, enable-received, enable-pending, enable-submtited, delete-received, delete-pending, delete-submitted, deleted]

The status of a notification setting

Responses

200: Returns a list of notification settings.

application/json

• Schema
• Example (from schema)

Schema

data

NotificationSetting[]

Array [

id string

A UUID.

notification_event_condition_id string

A UUID reference to the associated Notification Event Condition.

notification_profile_id string

A UUID reference to the associated Notification Profile.

associated_record_type string

associated_record_type_value string

status string

Possible values: [enabled, enable-received, enable-pending, enable-submtited, delete-received, delete-pending, delete-submitted, deleted]

Most preferences apply immediately; however, other may needs to propagate.

notification_channel_id string

A UUID reference to the associated Notification Channel.

parameters

object[]

Array [

name string

value string

]

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was updated.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "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
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...