Retrieves a continuation-based page of Contracts.

POST /api/contracts/list/continuation deprecated

Requires: Customers.Contracts, merchant scope.

Requires API key scope: admin (Administration)

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

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/contracts/list/continuation" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "customerId": "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 = @'
{
  "customerId": "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/contracts/list/continuation' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.contractsGetContinuationList({
  "customerId": "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/contracts/list/continuation', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customerId": "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 ContractsApi(config);
var body = JsonSerializer.Deserialize<GetContractContinuationInput>("""
    {
      "customerId": "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.ContractsGetContinuationListAsync(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/contracts/list/continuation");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "customerId": "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.ContractsApi(client)
    body = winkpg_api.GetContractContinuationInput.from_dict({
      "customerId": "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.contracts_get_continuation_list(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "customerId": "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/contracts/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.

Request body

application/json , required

Field Type Description

customerId required

string (uuid)

Gets or sets an optional customer identifier to filter contracts by owner. 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 contracts 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 contracts 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: ContinuationPagedResultDtoOfContractDto ContinuationPagedResultDtoOfContractDto Each item has these fields.

Field Type Description

items required

array of ContractDto array of ContractDto

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

Field Type Description

extraProperties required

object

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

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.

customerId required

string (uuid)

Gets or sets the identifier of the customer who owns this contract.

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.

customerName required

string

Gets or sets the display name of the associated customer, used for grid rendering. 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.

legacyNumber required

integer (int64)

Gets or sets the contract's legacy numeric key, the integer identifier the v1 API resolves contracts by. Server-owned: stamped at create and ignored on every inbound payload. Null on contracts created before the field existed and not yet back-filled by the v1 data migration. 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.

totalExecutions required

integer (int32)

Gets or sets the total number of billing executions performed for this contract.

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.

successfulExecutions required

integer (int32)

Gets or sets the number of successful billing executions.

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.

failedExecutions required

integer (int32)

Gets or sets the number of failed billing executions.

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.

totalAmountBilled required

number (double)

Gets or sets the cumulative amount billed across all executions.

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.

amountPerAttempt required

number (double)

Gets or sets the amount charged per billing attempt.

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.

paymentMethodType required

ContractPayMethodType ContractPayMethodType

Gets or sets the type of payment method used by this contract.

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.

`Card`
`Check`

customFields required

array of ContractCustomField array of ContractCustomField

Gets or sets the merchant-defined custom field values carried on this contract, or null when it carries none. Null and an empty collection are different answers: null means the contract has never had custom fields set, empty means they were explicitly cleared. 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.

perBillInvoice required

ContractPerBillInvoice ContractPerBillInvoice

Gets or sets the per-bill invoice configuration for this contract.

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.

thresholds required

ContractThresholds ContractThresholds

Gets or sets the threshold rules governing contract execution limits.

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.

aggregates required

ContractAggregates ContractAggregates

Gets or sets aggregate billing totals tracked across contract executions.

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.

schedule required

ContractSchedule ContractSchedule

Gets or sets the recurrence schedule for contract execution.

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.

payMethod required

ContractPayMethod ContractPayMethod

Gets or sets the payment method configuration used when the contract is billed.

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.

emailNotifications required

ContractEmailNotifications ContractEmailNotifications

Gets or sets the email notification settings for contract billing events.

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.

isActive required

boolean

Gets or sets a value indicating whether this contract is active and eligible for execution.

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.

planId required

string (uuid)

Gets or sets the reusable plan this contract subscribes to for its price, or null when the contract carries its own inline amount. When set, the recurring billing engine resolves the amount from the plan at charge time and the per-bill amounts on this contract are a snapshot of 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.

trialEndDate required

string (date-time)

Gets or sets the calendar day the contract's trial ends, in UTC, or null when the contract has no trial. While this day is still ahead the contract is active but not charged; the first charge falls on it, or on the schedule's first occurrence after it, at the full amount. 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.

description required

string

Gets or sets an optional description providing additional context for the contract. 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.

deactivationReason required

ContractDeactivationReason ContractDeactivationReason

Gets or sets the reason this contract was deactivated, or null when the contract is active or was never deactivated. Server-owned: set by the recurring billing engine when a threshold or schedule ends the contract, by the self-service cancellation flow when the payer cancels, and cleared back to null when the contract is reactivated. Read-only over the API; an inbound payload can never set it. nullableread 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.

`Suspended`	Suspended by the billing engine after consecutive failures exceeded the maxFailCount threshold.
`MaxPaymentsReached`	Total execution count (successful + failed) reached maxNumPayments.
`MaxSuccessfulBillsReached`	Successful execution count reached maxSuccessfulBills.
`MaxAmountReached`	Cumulative amount billed reached maxAmount.
`ScheduleExhausted`	The recurrence schedule produced no further occurrences: either the until end date was reached or the recurrence count was exhausted.
`Manual`	Manually deactivated by an operator via the UI or API.
`CancelledByCardholder`	Cancelled by the cardholder themselves, from the link in an upcoming-charge reminder, with no operator involved.
`Paused`	Paused on purpose by an operator, to be resumed later: either by hand, or automatically by the daily billing run once the contract's expected resume date has passed. A pause is a voluntary stop, which is what separates it from Suspended (the billing engine gave up after consecutive failures) and from Manual (deactivated with no intention to resume). The pause itself is described by the contract's pause fields (reason, paused date, expected resume date), which are cleared when the contract resumes.

pauseReason required

string

Gets or sets why an operator paused this contract, or null when it is not paused. Present only while `deactivationReason` is `Paused`. Server-owned: written by the pause operation and cleared by every resume; read-only over the API. nullableread 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.

pausedDate required

string (date-time)

Gets or sets when the contract was paused, in UTC, or null when it is not paused. Server-owned and read-only over the API. nullableread 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.

expectedResumeDate required

string (date-time)

Gets or sets the UTC calendar day on which the daily billing run resumes the contract on its own, or null for a pause only an operator ends. Server-owned and read-only over the API; set it through the pause operation. nullableread 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.

convenienceFeeWaived required

boolean

Gets or sets whether the cardholder enrolled in this contract on terms that disclosed no convenience fee, so no scheduled charge under it carries one. Null or false means each charge's fee follows the merchant's convenience-fee configuration. Server-owned: recorded when the contract is created from a hosted payment page that carried no fee, and read-only over the API. nullableread 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.

name required

string

Gets or sets the display name of the contract. 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.

notes required

array of EntityNote array of EntityNote

Gets or sets the collection of notes attached to this contract. 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.

tags required

array of EntityTag array of EntityTag

Gets or sets the collection of tags used to categorize this contract. 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

Gets or sets the concurrency stamp used for optimistic concurrency control. 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.

entityVersion required

integer (int32)

Gets the entity version, incremented on each modification for optimistic concurrency. 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.

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.

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

The API reference isn't available right now

No such operation

This reference may be out of date

Retrieves a continuation-based page of Contracts.

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