Get a list of NotificationDestinations

GET /api/notifications/destinations deprecated

Requires: Notifications.Destinations, merchant scope.

Return a list of NotificationDestinations based on permissions and optional filters

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 . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/notifications/destinations" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/notifications/destinations' `
    -Headers $headers

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.notificationsGetListDestinations();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/destinations', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

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

var api = new NotificationsApi(config);
var result = await api.NotificationsGetListDestinationsAsync();

C# (raw HTTP)

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

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

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)
    result = api.notifications_get_list_destinations()

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

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

Parameters

Name	In	Type	Description
`Type` required	query	DestinationType	Filter by destination type.
`IsEnabled` required	query	boolean	Filter by enabled/disabled status.
`Status` required	query	DestinationStatus	Filter by health status.
`Filter` required	query	string	Gets or sets a general filter string for the result set.
`Name` required	query	string	Gets or sets the name filter for the result set.
`IncludeDeleted` required	query	boolean	Gets or sets a value indicating whether to include deleted entities in the result set.
`IncludeInactive` required	query	boolean	Gets or sets a value indicating whether to include inactive entities in the result set.
`Ids` required	query	array of string (uuid)	Gets or sets a list of entity IDs to filter the result set.
`Sorting` required	query	string
`SkipCount` required	query	integer (int32)
`MaxResultCount` required	query	integer (int32)
`ExtraProperties` required	query	object
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.