Counts the Customers that match a filter.

POST /api/customers/list/continuation/count deprecated

Requires: Customers.Customers, merchant scope.

Requires API key scope: customers ()

Takes the same request body as the continuation list endpoint and returns how many Customers 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 GetCustomerContinuationInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/customers/list/continuation/count" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "sorting": {},
  "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

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

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "sorting": {},
  "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/customers/list/continuation/count' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.customersGetApproximateTotalCount({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "sorting": {},
  "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)

const response = await fetch('{{BASE_URL}}/api/customers/list/continuation/count', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "filter": {},
    "maxResultCount": 0,
    "continuationToken": "",
    "sorting": {},
    "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();

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 CustomersApi(config);
var body = JsonSerializer.Deserialize<GetCustomerContinuationInput>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "filter": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "sorting": {},
      "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.CustomersGetApproximateTotalCountAsync(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/customers/list/continuation/count");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "filter": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "sorting": {},
      "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();

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.CustomersApi(client)
    body = winkpg_api.GetCustomerContinuationInput.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "filter": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "sorting": {},
      "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.customers_get_approximate_total_count(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "sorting": {},
  "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/customers/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.

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

merchantId required

string (uuid)

Gets or sets an optional merchant identifier to filter customers by their owning merchant. 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.

filter required

FilterGroup FilterGroup

Gets or sets the filter group containing advanced filter expressions.

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)

Gets or sets the maximum number of results to return per page.

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

Gets or sets the continuation token from a previous query for retrieving the next 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.

sorting required

SortDescriptor SortDescriptor

Gets or sets the sort descriptor controlling result ordering.

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.

maxCreationTime required

string (date-time)

Gets or sets the upper bound for filtering by creation time. 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.

minCreationTime required

string (date-time)

Gets or sets the lower bound for filtering by creation time. 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.

maxModificationTime required

string (date-time)

Gets or sets the upper bound for filtering by last modification time. 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.

maxModifitionTime required

string (date-time)

Deprecated misspelled alias of `maxModificationTime`. nullabledeprecated

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.

minModificationTime required

string (date-time)

Gets or sets the lower bound for filtering by last modification time. 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.

minModifitionTime required

string (date-time)

Deprecated misspelled alias of `minModificationTime`. nullabledeprecated

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

Gets or sets a value indicating whether soft-deleted customers should be included in results.

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

Gets or sets a value indicating whether inactive customers should be included in results.

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

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

Field	Type	Description

This response has no documented body fields.

403 Forbidden

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.

401 Unauthorized

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.

400 Bad Request

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.

404 Not Found

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.

501 Not Implemented

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.

500 Internal Server Error

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.

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.

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

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 Customers

The API reference isn't available right now

No such operation

This reference may be out of date

Counts the Customers that match a filter.

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

501 Not Implemented

500 Internal Server Error

Errors

Authentication