Retrieves a continuation-based page of the acting merchant's invitations.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/developer-portal/invitations/list/continuation" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": {},
  "status": {},
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": false
  },
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
}'

PowerShell

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

$body = @'
{
  "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": {},
  "status": {},
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": false
  },
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
}
'@

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.developerPortalGetContinuationListInvitations({
  "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": {},
  "status": {},
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": false
  },
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/developer-portal/invitations/list/continuation', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "role": {},
    "status": {},
    "filter": {
      "logic": "And",
      "rules": [],
      "groups": []
    },
    "maxResultCount": 1,
    "continuationToken": "",
    "sorting": {
      "field": "",
      "descending": false
    },
    "minCreationTime": "2026-01-01T00:00:00Z",
    "maxCreationTime": "2026-01-01T00:00:00Z",
    "includeDeleted": false,
    "includeInactive": false,
    "includeApproxTotalCount": false
  }),
});

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 DeveloperPortalApi(config);
var body = JsonSerializer.Deserialize<GetDeveloperPortalInvitationContinuationInput>("""
    {
      "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "role": {},
      "status": {},
      "filter": {
        "logic": "And",
        "rules": [],
        "groups": []
      },
      "maxResultCount": 1,
      "continuationToken": "",
      "sorting": {
        "field": "",
        "descending": false
      },
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false
    }
    """);

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

request.Content = new StringContent("""
    {
      "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "role": {},
      "status": {},
      "filter": {
        "logic": "And",
        "rules": [],
        "groups": []
      },
      "maxResultCount": 1,
      "continuationToken": "",
      "sorting": {
        "field": "",
        "descending": false
      },
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxCreationTime": "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();

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.DeveloperPortalApi(client)
    body = winkpg_api.GetDeveloperPortalInvitationContinuationInput.from_dict({
      "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "role": {},
      "status": {},
      "filter": {
        "logic": "And",
        "rules": [],
        "groups": []
      },
      "maxResultCount": 1,
      "continuationToken": "",
      "sorting": {
        "field": "",
        "descending": False
      },
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "includeDeleted": False,
      "includeInactive": False,
      "includeApproxTotalCount": False
    })
    result = api.developer_portal_get_continuation_list_invitations(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "invitedIdentityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": {},
  "status": {},
  "filter": {
    "logic": "And",
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": False
  },
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "includeDeleted": False,
  "includeInactive": False,
  "includeApproxTotalCount": False
}

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

X-Acting-Merchant-Id required

header

string (uuid)

The merchant to act for. Optional: when absent, the caller's own merchant scope answers. A caller whose identity carries no merchant scope, such as an administrator, must send it. The selection is authorized on every operation; a merchant the caller may not act for is refused.

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

invitedIdentityUserId required

string (uuid)

Scope to a single invited identity user. 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.

role required

DeveloperPortalRole DeveloperPortalRole

Scope to a single portal role. Conditional: When Role is not null. 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.

`Admin`	Full portal access: reads everything the read-only role does and additionally manages the merchant's portal configuration.
`ReadOnly`	Read-only portal access.

status required

DeveloperPortalInvitationStatus DeveloperPortalInvitationStatus

Scope to a single lifecycle state, matched against the <b>stored</b> status. Conditional: When Status is not null. 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.

`Pending`	Issued, not yet redeemed, and not yet past its expiry.
`Redeemed`	Redeemed. The developer account it created exists.
`Expired`	Past its expiry without having been redeemed.
`Revoked`	Withdrawn by an operator before it was redeemed.

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.

maxResultCount required

integer (int32)

min 1max 100

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.

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.

minCreationTime required

string (date-time)

The date and time when this entity was created. 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.

maxCreationTime required

string (date-time)

The date and time when this entity was created. 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.

This request body has no documented fields.

Responses

200 OK

OK

Body: ContinuationPagedResultDtoOfDeveloperPortalInvitationDto ContinuationPagedResultDtoOfDeveloperPortalInvitationDto Each item has these fields.

Field Type Description

items required

array of DeveloperPortalInvitationDto array of DeveloperPortalInvitationDto

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 DeveloperPortalInvitationDto:

Field Type Description

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.

merchantId required

string (uuid)

The merchant the invitation offers access to, or `null` when it offers access to a reseller. Exactly one of this and `resellerId` is set. 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.

resellerId required

string (uuid)

The reseller the invitation offers access to, or `null` when it offers access to a merchant. Exactly one of this and `merchantId` is set. 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.

email required

string

The address the invitation was emailed to. 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.

invitedIdentityUserId required

string (uuid)

The identity user the invitation is for, and the only one who can redeem it. 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.

role required

DeveloperPortalRole DeveloperPortalRole

The portal capability a redemption will grant. 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.

`Admin`	Full portal access: reads everything the read-only role does and additionally manages the merchant's portal configuration.
`ReadOnly`	Read-only portal access.

expiresAt required

string (date-time)

When the invitation stops being redeemable, in UTC. The contract stays UTC in and UTC out; display surfaces convert it to the viewer's time zone. 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

DeveloperPortalInvitationStatus DeveloperPortalInvitationStatus

The lifecycle state, already resolved against the clock by the reader. 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.

`Pending`	Issued, not yet redeemed, and not yet past its expiry.
`Redeemed`	Redeemed. The developer account it created exists.
`Expired`	Past its expiry without having been redeemed.
`Revoked`	Withdrawn by an operator before it was redeemed.

issuedByUserId required

string (uuid)

The back-office user who issued the invitation. 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.

redeemedAt required

string (date-time)

When the invitation was redeemed, in UTC, or `null` if it never was. 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.

revokedAt required

string (date-time)

When the invitation was revoked, in UTC, or `null` if it never was. 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.

concurrencyStamp required

string

Optimistic-concurrency token. 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.

user required

DeveloperPortalUserSummaryDto DeveloperPortalUserSummaryDto

The identity half of the invited party: who they are, and whether they already hold a back-office role. `null` when the reader did not enrich the row.

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.

429 Too Many Requests

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 400 401 403 404 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
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.

Fields of RemoteServiceErrorInfo:

Field Type Description

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

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

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

data required

object

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.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

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 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 Developer Portal

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Retrieves a continuation-based page of the acting merchant's invitations.

Example request

Parameters

Request body

Responses

Errors

Authentication