---
title: "List notification settings"
method: GET
path: "/notification-settings"
tags: ["Notification settings"]
---

# List notification settings

`GET /notification-settings`

## Request

- Base URL: `https://sandbox-api.paddle.com`
- URL: `https://sandbox-api.paddle.com/notification-settings`
- Auth: HTTP bearer

Returns a paginated list of notification settings (notification destinations).

## Query parameters

- `after` string
- `per_page` integer
- `order_by` string
- `active` boolean
- `traffic_source` 'platform' | 'simulation' | 'all': Whether Paddle should deliver real platform events, simulation events or both to this notification destination.

## Headers

- `Skip-Count` string

## Response `200`

The request has succeeded.

- object
  - `data` NotificationSetting[], required
    - `id` string, required: Unique Paddle ID for this notification setting, prefixed with `ntfset_`.
    - `description` string, required: Short description for this notification destination. Shown in the Paddle dashboard.
    - `type` 'email' | 'url', required: Where notifications should be sent for this destination.
    - `destination` string, required: Webhook endpoint URL or email address.
    - `active` boolean, required: Whether Paddle should try to deliver events to this notification destination.
    - `api_version` integer, required: API version that returned objects for events should conform to. Must be a valid version of the Paddle API. Can't be a version older than your account default.
    - `include_sensitive_fields` boolean, required: Whether potentially sensitive fields should be sent to this notification destination.
    - `subscribed_events` EventType[], required: Subscribed events for this notification destination.
      - `name` 'address.created' | 'address.imported' | 'address.updated' | 'adjustment.created' | 'adjustment.updated' | 'api_key.created' | 'api_key.expired' | 'api_key.expiring' | 'api_key.revoked' | 'api_key.updated' | 'api_key_exposure.created' | 'business.created' | 'business.imported' | 'business.updated' | 'client_token.created' | 'client_token.revoked' | 'client_token.updated' | 'customer.created' | 'customer.imported' | 'customer.updated' | 'discount.created' | 'discount.imported' | 'discount.updated' | 'discount_group.created' | 'discount_group.updated' | 'payment_method.saved' | 'payment_method.deleted' | 'payout.created' | 'payout.paid' | 'price.created' | 'price.imported' | 'price.updated' | 'product.created' | 'product.imported' | 'product.updated' | 'report.created' | 'report.updated' | 'subscription.activated' | 'subscription.canceled' | 'subscription.created' | 'subscription.imported' | 'subscription.past_due' | 'subscription.paused' | 'subscription.resumed' | 'subscription.trialing' | 'subscription.updated' | 'transaction.billed' | 'transaction.canceled' | 'transaction.completed' | 'transaction.created' | 'transaction.paid' | 'transaction.past_due' | 'transaction.payment_failed' | 'transaction.ready' | 'transaction.revised' | 'transaction.updated', required: Type of event sent by Paddle, in the format `entity.event_type`.
      - `description` string, required: Short description of this event type.
      - `group` string, required: Group for this event type. Typically the entity that this event relates to.
      - `available_versions` integer[], required: List of API versions that this event type supports.
    - `endpoint_secret_key` string, required: Webhook destination secret key, prefixed with `pdl_ntfset_`. Used for signature verification.
    - `traffic_source` 'platform' | 'simulation' | 'all', required: Whether Paddle should deliver real platform events, simulation events or both to this notification destination.
  - `meta` PaginatedMeta, required: Information about this response.
    - `request_id` string, required: Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
    - `pagination` Pagination, required: Keys used for working with paginated results.
      - `per_page` integer, required: Number of entities per page for this response. May differ from the number requested if the requested number is greater than the maximum.
      - `next` string, uri, required: URL containing the query parameters of the original request, along with the `after` parameter that marks the starting point of the next page. Always returned, even if `has_more` is `false`.
      - `has_more` boolean, required: Whether this response has another page.
      - `estimated_total` integer: Estimated number of entities for this response. For datasets with 100,000 or fewer matches, returns the exact count. For datasets with more than 100,000 matches, returns `100001` to indicate that more than 100,000 entities match. Returns `-1` when counting is skipped or couldn't be calculated. Use `has_more` and `next` to page through all results rather than relying on `estimated_total` for an exact count.

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-07-09** (v1) `e1ac347eb3c5`: 1 info
  - added the new optional `header` request parameter `Skip-Count`
- **2026-02-02** (v1) `9ba8be0f2006`: 9 breaking, 1 warning, 77 info
  - the `data/items/id` response's property type changed from `string` to no type for status `200`
  - the `data/items/subscribed_events/items/name` response's property type changed from `string` to no type for status `200`
  - the `data/items/traffic_source` response's property type changed from `string` to no type for status `200`
  - the `data/items/type` response's property type changed from `string` to no type for status `200`
  - …83 more
- **2025-05-27** (v1) `e57c515077cc`: 5 warning
  - added the new `api_key.created` enum value to the `data/items/subscribed_events/items/name` response property for the response status `200`
  - added the new `api_key.expired` enum value to the `data/items/subscribed_events/items/name` response property for the response status `200`
  - added the new `api_key.expiring` enum value to the `data/items/subscribed_events/items/name` response property for the response status `200`
  - added the new `api_key.revoked` enum value to the `data/items/subscribed_events/items/name` response property for the response status `200`
  - …1 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/paddlehq/apis/paddle-api/changes/notification-settings/get.md)

---

[API](https://skmtc.dev/paddlehq/apis/paddle-api.md) - [All operations](https://skmtc.dev/paddlehq/apis/paddle-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paddlehq/apis/paddle-api/revisions/bbc0c72039c8?raw)