# POST /api/notifications/subscriptions/list/continuation

Retrieves a continuation-based page of NotificationSubscriptions.

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

**Operation ID:** `notificationsGetContinuationListSubscriptions`

## Authorization

Requires: Notifications.Subscriptions, merchant scope.

Required permissions:
- `Notifications.Subscriptions`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

**Content type:** `application/json`

Schema: `GetNotificationSubscriptionContinuationInput`

Properties:
- `scope` (object): Filter by organizational scope.
- `isEnabled` (boolean): Filter by enabled/disabled status.
- `maxResultCount` (integer(int32))
- `continuationToken` (string)
- `includeDeleted` (boolean)
- `includeInactive` (boolean)
- `includeApproxTotalCount` (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.
- `sorting` (SortDescriptor)
- `filter` (FilterGroup)

**Content type:** `text/json`

Schema: `GetNotificationSubscriptionContinuationInput`

Properties:
- `scope` (object): Filter by organizational scope.
- `isEnabled` (boolean): Filter by enabled/disabled status.
- `maxResultCount` (integer(int32))
- `continuationToken` (string)
- `includeDeleted` (boolean)
- `includeInactive` (boolean)
- `includeApproxTotalCount` (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.
- `sorting` (SortDescriptor)
- `filter` (FilterGroup)

**Content type:** `application/*+json`

Schema: `GetNotificationSubscriptionContinuationInput`

Properties:
- `scope` (object): Filter by organizational scope.
- `isEnabled` (boolean): Filter by enabled/disabled status.
- `maxResultCount` (integer(int32))
- `continuationToken` (string)
- `includeDeleted` (boolean)
- `includeInactive` (boolean)
- `includeApproxTotalCount` (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.
- `sorting` (SortDescriptor)
- `filter` (FilterGroup)

## Responses

### 200

OK

**Content type:** `application/json`

Schema: `ContinuationPagedResultDtoOfNotificationSubscriptionDto`

Properties:
- `items` (array<NotificationSubscriptionDto>): The items returned for this page.
- `nextContinuationToken` (string): Continuation token to use when requesting the next page.  Null means no additional pages exist.
- `approxTotalCount` (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.
- `pageItemCount` (integer(int32)): Convenience property for the number of items in this page.
- `retrievedAt` (string(date-time)): When the page was retrieved. Useful for diagnostics and cache behavior.

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

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

### cURL

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

### PowerShell

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

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

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

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

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

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

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

### TypeScript (raw HTTP)

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

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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<GetNotificationSubscriptionContinuationInput>("""
    {
      "scope": {},
      "isEnabled": false,
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false,
      "sorting": {
        "field": "",
        "descending": false
      },
      "filter": {
        "logic": {},
        "rules": [],
        "groups": []
      }
    }
    """);

var result = await api.NotificationsGetContinuationListSubscriptionsAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

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

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

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

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

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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.GetNotificationSubscriptionContinuationInput.from_dict({
      "scope": {},
      "isEnabled": False,
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": False,
      "includeInactive": False,
      "includeApproxTotalCount": False,
      "sorting": {
        "field": "",
        "descending": False
      },
      "filter": {
        "logic": {},
        "rules": [],
        "groups": []
      }
    })
    result = api.notifications_get_continuation_list_subscriptions(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

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

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

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.