Skip to main content

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.

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

default: Unexpected error

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
  • ]

Loading...