Retrieves a continuation-based page of NotificationDestinations.

POST /api/notifications/destinations/list/continuation deprecated

Requires: Notifications.Destinations, merchant scope.

Requires API key scope: webhooks ()

This endpoint uses continuation tokens instead of skip/take paging.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a GetNotificationDestinationContinuationInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/notifications/destinations/list/continuation" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "type": {},
  "isEnabled": false,
  "status": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false,
  "sorting": {
    "field": "",
    "descending": false
  },
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  }
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "type": {},
  "isEnabled": false,
  "status": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false,
  "sorting": {
    "field": "",
    "descending": false
  },
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  }
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/notifications/destinations/list/continuation' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, NotificationsApi } from '@winkpg/winkpg-api';

const api = new NotificationsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.notificationsGetContinuationListDestinations({
  "type": {},
  "isEnabled": false,
  "status": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false,
  "sorting": {
    "field": "",
    "descending": false
  },
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  }
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/destinations/list/continuation', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": {},
    "isEnabled": false,
    "status": {},
    "maxResultCount": 0,
    "continuationToken": "",
    "includeDeleted": false,
    "includeInactive": false,
    "includeApproxTotalCount": false,
    "sorting": {
      "field": "",
      "descending": false
    },
    "filter": {
      "logic": "And",
      "rules": [],
      "groups": []
    }
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new NotificationsApi(config);
var body = JsonSerializer.Deserialize<GetNotificationDestinationContinuationInput>("""
    {
      "type": {},
      "isEnabled": false,
      "status": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false,
      "sorting": {
        "field": "",
        "descending": false
      },
      "filter": {
        "logic": "And",
        "rules": [],
        "groups": []
      }
    }
    """);

var result = await api.NotificationsGetContinuationListDestinationsAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/notifications/destinations/list/continuation");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "type": {},
      "isEnabled": false,
      "status": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false,
      "sorting": {
        "field": "",
        "descending": false
      },
      "filter": {
        "logic": "And",
        "rules": [],
        "groups": []
      }
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.NotificationsApi(client)
    body = winkpg_api.GetNotificationDestinationContinuationInput.from_dict({
      "type": {},
      "isEnabled": False,
      "status": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": False,
      "includeInactive": False,
      "includeApproxTotalCount": False,
      "sorting": {
        "field": "",
        "descending": False
      },
      "filter": {
        "logic": "And",
        "rules": [],
        "groups": []
      }
    })
    result = api.notifications_get_continuation_list_destinations(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "type": {},
  "isEnabled": False,
  "status": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": False,
  "includeInactive": False,
  "includeApproxTotalCount": False,
  "sorting": {
    "field": "",
    "descending": False
  },
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  }
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/notifications/destinations/list/continuation",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description

type required

DestinationType DestinationType

Filter by destination type. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Webhook`	HTTP POST to a configured URL with HMAC signature headers.
`Email`	Email delivery to the configured recipient addresses.
`AmazonSqs`	Amazon Simple Queue Service (SQS) message delivery.
`AzureServiceBusQueue`	Azure Service Bus Queue message delivery.
`InApp`	In-app notification delivered in-process to connected clients on this instance. Suitable for real-time UI notifications (dropdown, popup, badge).
`Slack`	Slack message delivery via Block Kit-formatted channel messages. Supports per-destination bot tokens for multi-workspace routing.
`Sms`	SMS text message delivery to a single recipient phone number via the platform SMS sender. Opt-out compliance is enforced at send time, so an opted-out recipient is blocked before the carrier is contacted.

isEnabled required

boolean

Filter by enabled/disabled status. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

status required

DestinationStatus DestinationStatus

Filter by health status. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Default`	Destination has not been tested or is operating normally.
`ConfigurationError`	Destination configuration is invalid (e.g., malformed URL, missing credentials).
`ThrottlingWarning`	Destination is responding but rate-limiting or throttling requests.
`ExternalServerError`	External server returned 5xx errors.
`TimeoutError`	Delivery timed out waiting for response.
`AuthError`	Authentication or authorization failure (401/403).
`UnknownError`	An unclassified error occurred during delivery.

maxResultCount required

integer (int32)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

continuationToken required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

includeDeleted required

boolean

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

includeInactive required

boolean

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

includeApproxTotalCount required

boolean

Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count as before. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

sorting required

SortDescriptor SortDescriptor

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of SortDescriptor:

Field Type Description

field required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

descending required

boolean

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

filter required

FilterGroup FilterGroup

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of FilterGroup:

Field Type Description

logic required

FilterLogic FilterLogic

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`And`
`Or`

rules required

array of FilterRule array of FilterRule

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

groups required

array of FilterGroup array of FilterGroup

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This request body has no documented fields.

Responses

200 OK

Body: ContinuationPagedResultDtoOfNotificationDestinationDto ContinuationPagedResultDtoOfNotificationDestinationDto Each item has these fields.

Field Type Description

items required

array of NotificationDestinationDto array of NotificationDestinationDto

The items returned for this page. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each NotificationDestinationDto:

Field Type Description

extraProperties required

object

nullableread only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creationTime required

string (date-time)

The date and time when this entity was created.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creatorId required

string (uuid)

The ID of the user who created this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModificationTime required

string (date-time)

The date and time when this entity was last modified. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModifierId required

string (uuid)

The ID of the user who last modified this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDeleted required

boolean

Indicates whether this entity has been deleted.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deleterId required

string (uuid)

The ID of the user who deleted this entity, if it is deleted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deletionTime required

string (date-time)

The date and time when this entity was deleted, if it is deleted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

name required

string

Destination name. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

Optional description. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

type required

DestinationType DestinationType

The delivery transport type.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Webhook`	HTTP POST to a configured URL with HMAC signature headers.
`Email`	Email delivery to the configured recipient addresses.
`AmazonSqs`	Amazon Simple Queue Service (SQS) message delivery.
`AzureServiceBusQueue`	Azure Service Bus Queue message delivery.
`InApp`	In-app notification delivered in-process to connected clients on this instance. Suitable for real-time UI notifications (dropdown, popup, badge).
`Slack`	Slack message delivery via Block Kit-formatted channel messages. Supports per-destination bot tokens for multi-workspace routing.
`Sms`	SMS text message delivery to a single recipient phone number via the platform SMS sender. Opt-out compliance is enforced at send time, so an opted-out recipient is blocked before the carrier is contacted.

configJson required

string

Type-specific configuration JSON. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

status required

DestinationStatus DestinationStatus

Current health status.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Default`	Destination has not been tested or is operating normally.
`ConfigurationError`	Destination configuration is invalid (e.g., malformed URL, missing credentials).
`ThrottlingWarning`	Destination is responding but rate-limiting or throttling requests.
`ExternalServerError`	External server returned 5xx errors.
`TimeoutError`	Delivery timed out waiting for response.
`AuthError`	Authentication or authorization failure (401/403).
`UnknownError`	An unclassified error occurred during delivery.

lastErrorDetail required

string

Detail from the last error, if any. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastTestedAtUtc required

string (date-time)

UTC timestamp of the last test or health check. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isEnabled required

boolean

Whether the destination is enabled.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

scope required

EntityScopeKind EntityScopeKind

Ownership scope of this destination: merchant, reseller, or tenant-wide (admin-owned). Stamped server-side at creation from the creating caller's operating context and never settable through the create or update DTO. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Merchant`	Row applies to a single merchant. MerchantId must be non-null.
`Reseller`	Row applies to a reseller and (by entity-specific semantics) its descendants. ResellerId must be non-null.
`Tenant`	Row applies tenant-wide. Visible only to unscoped (admin) callers.

resellerId required

string (uuid)

Owning reseller, set only for a reseller-scoped destination. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

merchantId required

string (uuid)

Owning merchant, set only for a merchant-scoped destination. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppression required

DestinationSuppressionStateDto DestinationSuppressionStateDto

Durable suppression state for this destination's endpoint, or `null` when the endpoint has never failed (or when the transport type has no endpoint concept).

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

concurrencyStamp required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

tenantId required

string (uuid)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

entityVersion required

integer (int32)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

nextContinuationToken required

string

Continuation token to use when requesting the next page. Null means no additional pages exist. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

approxTotalCount required

integer (int64)

An approximate total count of matching items. This value is optional and may be stale or estimated, so treat it as an approximation. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

pageItemCount required

integer (int32)

Convenience property for the number of items in this page. read only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

retrievedAt required

string (date-time)

When the page was retrieved. Useful for diagnostics and cache behavior.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take. The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Notifications

The API reference isn't available right now

No such operation

This reference may be out of date

Retrieves a continuation-based page of NotificationDestinations.

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

501 Not Implemented

500 Internal Server Error

Errors

Authentication