# POST /api/promotions/list/continuation

Retrieves a continuation-based page of Promotions.

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

**Operation ID:** `promotionsGetContinuationList`

## Authorization

Requires: Promotions.Promotions, merchant scope.

Required permissions:
- `Promotions.Promotions`

## Parameters

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

## Request Body

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

Schema: `GetPromotionContinuationInput`

Properties:
- `merchantId` (string(uuid)): Scope to a single merchant. A merchant-scoped request is cheaper and faster than an unscoped one.
- `isActive` (boolean): Scope to promotions that are switched on, or to those that are switched off.
- `discountType` (object): Scope to one discount type. Conditional: When DiscountType is not null.
- `filter` (FilterGroup)
- `maxResultCount` (integer(int32))
- `continuationToken` (string)
- `sorting` (SortDescriptor)
- `maxCreationTime` (string(date-time)): Upper bound on creation time.
- `minCreationTime` (string(date-time)): Lower bound on creation time.
- `maxModificationTime` (string(date-time)): Upper bound on last-modification time.
- `maxModifitionTime` (string(date-time)): Deprecated misspelled alias of `maxModificationTime`.
- `minModificationTime` (string(date-time)): Lower bound on last-modification time.
- `minModifitionTime` (string(date-time)): Deprecated misspelled alias of `minModificationTime`.
- `includeDeleted` (boolean)
- `includeInactive` (boolean)
- `includeApproxTotalCount` (boolean): Set to false to skip the approximate total count and receive a null count; omit it or set it  to true to receive the count as before.

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

Schema: `GetPromotionContinuationInput`

Properties:
- `merchantId` (string(uuid)): Scope to a single merchant. A merchant-scoped request is cheaper and faster than an unscoped one.
- `isActive` (boolean): Scope to promotions that are switched on, or to those that are switched off.
- `discountType` (object): Scope to one discount type. Conditional: When DiscountType is not null.
- `filter` (FilterGroup)
- `maxResultCount` (integer(int32))
- `continuationToken` (string)
- `sorting` (SortDescriptor)
- `maxCreationTime` (string(date-time)): Upper bound on creation time.
- `minCreationTime` (string(date-time)): Lower bound on creation time.
- `maxModificationTime` (string(date-time)): Upper bound on last-modification time.
- `maxModifitionTime` (string(date-time)): Deprecated misspelled alias of `maxModificationTime`.
- `minModificationTime` (string(date-time)): Lower bound on last-modification time.
- `minModifitionTime` (string(date-time)): Deprecated misspelled alias of `minModificationTime`.
- `includeDeleted` (boolean)
- `includeInactive` (boolean)
- `includeApproxTotalCount` (boolean): Set to false to skip the approximate total count and receive a null count; omit it or set it  to true to receive the count as before.

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

Schema: `GetPromotionContinuationInput`

Properties:
- `merchantId` (string(uuid)): Scope to a single merchant. A merchant-scoped request is cheaper and faster than an unscoped one.
- `isActive` (boolean): Scope to promotions that are switched on, or to those that are switched off.
- `discountType` (object): Scope to one discount type. Conditional: When DiscountType is not null.
- `filter` (FilterGroup)
- `maxResultCount` (integer(int32))
- `continuationToken` (string)
- `sorting` (SortDescriptor)
- `maxCreationTime` (string(date-time)): Upper bound on creation time.
- `minCreationTime` (string(date-time)): Lower bound on creation time.
- `maxModificationTime` (string(date-time)): Upper bound on last-modification time.
- `maxModifitionTime` (string(date-time)): Deprecated misspelled alias of `maxModificationTime`.
- `minModificationTime` (string(date-time)): Lower bound on last-modification time.
- `minModifitionTime` (string(date-time)): Deprecated misspelled alias of `minModificationTime`.
- `includeDeleted` (boolean)
- `includeInactive` (boolean)
- `includeApproxTotalCount` (boolean): Set to false to skip the approximate total count and receive a null count; omit it or set it  to true to receive the count as before.

## Responses

### 200

OK

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

Schema: `ContinuationPagedResultDtoOfPromotionDto`

Properties:
- `items` (array<PromotionDto>): 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 GetPromotionContinuationInput. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/promotions/list/continuation" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": false,
  "discountType": {},
  "filter": {
    "logic": {},
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": false
  },
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
}'
```

### PowerShell

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

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": false,
  "discountType": {},
  "filter": {
    "logic": {},
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": false
  },
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
}
'@

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

### TypeScript (SDK)

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

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

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

const { data } = await api.promotionsGetContinuationList({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": false,
  "discountType": {},
  "filter": {
    "logic": {},
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": false
  },
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/promotions/list/continuation', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isActive": false,
    "discountType": {},
    "filter": {
      "logic": {},
      "rules": [],
      "groups": []
    },
    "maxResultCount": 1,
    "continuationToken": "",
    "sorting": {
      "field": "",
      "descending": false
    },
    "maxCreationTime": "2026-01-01T00:00:00Z",
    "minCreationTime": "2026-01-01T00:00:00Z",
    "maxModificationTime": "2026-01-01T00:00:00Z",
    "maxModifitionTime": "2026-01-01T00:00:00Z",
    "minModificationTime": "2026-01-01T00:00:00Z",
    "minModifitionTime": "2026-01-01T00:00:00Z",
    "includeDeleted": false,
    "includeInactive": false,
    "includeApproxTotalCount": false
  }),
});

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 PromotionsApi(config);
var body = JsonSerializer.Deserialize<GetPromotionContinuationInput>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isActive": false,
      "discountType": {},
      "filter": {
        "logic": {},
        "rules": [],
        "groups": []
      },
      "maxResultCount": 1,
      "continuationToken": "",
      "sorting": {
        "field": "",
        "descending": false
      },
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxModificationTime": "2026-01-01T00:00:00Z",
      "maxModifitionTime": "2026-01-01T00:00:00Z",
      "minModificationTime": "2026-01-01T00:00:00Z",
      "minModifitionTime": "2026-01-01T00:00:00Z",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false
    }
    """);

var result = await api.PromotionsGetContinuationListAsync(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/promotions/list/continuation");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isActive": false,
      "discountType": {},
      "filter": {
        "logic": {},
        "rules": [],
        "groups": []
      },
      "maxResultCount": 1,
      "continuationToken": "",
      "sorting": {
        "field": "",
        "descending": false
      },
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxModificationTime": "2026-01-01T00:00:00Z",
      "maxModifitionTime": "2026-01-01T00:00:00Z",
      "minModificationTime": "2026-01-01T00:00:00Z",
      "minModifitionTime": "2026-01-01T00:00:00Z",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false
    }
    """, 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.PromotionsApi(client)
    body = winkpg_api.GetPromotionContinuationInput.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isActive": False,
      "discountType": {},
      "filter": {
        "logic": {},
        "rules": [],
        "groups": []
      },
      "maxResultCount": 1,
      "continuationToken": "",
      "sorting": {
        "field": "",
        "descending": False
      },
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxModificationTime": "2026-01-01T00:00:00Z",
      "maxModifitionTime": "2026-01-01T00:00:00Z",
      "minModificationTime": "2026-01-01T00:00:00Z",
      "minModifitionTime": "2026-01-01T00:00:00Z",
      "includeDeleted": False,
      "includeInactive": False,
      "includeApproxTotalCount": False
    })
    result = api.promotions_get_continuation_list(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": False,
  "discountType": {},
  "filter": {
    "logic": {},
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": False
  },
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": False,
  "includeInactive": False,
  "includeApproxTotalCount": False
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/promotions/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.