Retrieves a continuation-based page of Campaigns.
POST
/api/campaigns/list/continuation
deprecated
Requires: Campaigns.Campaigns, merchant scope.
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 GetCampaignContinuationInput. See the Request body section below for its fields.
Parameters
Request body
application/json
, required
| Field | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
merchantId
required |
string (uuid) | Scope to a single merchant. A merchant-scoped request is cheaper and faster than an unscoped one.
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 |
CampaignStatus CampaignStatus | Scope to a single stored campaign 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.
| ||||||||||||||||
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:
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:
This body has no documented fields. | ||||||||||||||||||
maxCreationTime
required |
string (date-time) | Upper bound on 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) | Lower bound on 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) | Upper bound on 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) | Lower bound on 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 |
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 and receive a null count; omit it 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
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.
Authentication
ApiKeywith scopes