Syntch Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-09 02:57 UTC.

API reference DeveloperPortal

Counts the DeveloperAccounts that match a filter.

POST /api/developer-portal/accounts/list/continuation/count deprecated

Requires: DeveloperPortal.Accounts, merchant scope.

Takes the same request body as the continuation list endpoint and returns how many DeveloperAccounts match it, without returning the records themselves. The count is approximate and is intended to sit alongside a paged list, so treat it as a display figure rather than a reconciliation total.

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

Code sample language

cURL

curl -X POST "{{BASE_URL}}/api/developer-portal/accounts/list/continuation/count" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "identityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": {},
  "status": {},
  "filter": {
    "logic": {},
    "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 = @'
{
  "identityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": {},
  "status": {},
  "filter": {
    "logic": {},
    "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/accounts/list/continuation/count' `
    -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.developerPortalGetApproximateTotalCountAccountsListContinuation({
  "identityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": {},
  "status": {},
  "filter": {
    "logic": {},
    "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/accounts/list/continuation/count', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "identityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "role": {},
    "status": {},
    "filter": {
      "logic": {},
      "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<GetDeveloperAccountContinuationInput>("""
    {
      "identityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "role": {},
      "status": {},
      "filter": {
        "logic": {},
        "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.DeveloperPortalGetApproximateTotalCountAccountsListContinuationAsync(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/accounts/list/continuation/count");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "identityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "role": {},
      "status": {},
      "filter": {
        "logic": {},
        "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.GetDeveloperAccountContinuationInput.from_dict({
      "identityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "role": {},
      "status": {},
      "filter": {
        "logic": {},
        "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_approximate_total_count_accounts_list_continuation(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "identityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": {},
  "status": {},
  "filter": {
    "logic": {},
    "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/accounts/list/continuation/count",
    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.
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.

Request body

application/json , required

Field Type Description
identityUserId required string (uuid) Scope to a single identity user. nullable
role required all of DeveloperPortalRole Scope to a single portal role. Conditional: When Role is not null. nullable
status required all of DeveloperAccountStatus Scope to a single access status. Conditional: When Status is not null. nullable
filter required FilterGroup
maxResultCount required integer (int32) min 1max 100
continuationToken required string nullable
sorting required SortDescriptor
minCreationTime required string (date-time) The date and time when this entity was created. nullable
maxCreationTime required string (date-time) The date and time when this entity was created. nullable
includeDeleted required boolean
includeInactive required boolean
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

This request body has no documented fields.

Responses

200 OK

Body: integer (int64) Each item has these fields.

Field Type Description

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

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

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

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 Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

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

    Reconnecting to the server

    Could not reconnect

    This session has ended

    Attempt 1

    Your work on this page is still here. Retrying keeps it; reloading starts the page again.

    The server no longer holds this page's state, so it has to be loaded again.