List campaigns

List all existing incentive campaign's. This endpoint uses cursor-based pagination. The response includes a cursor field—a base64-encoded string—that can be passed as the cursor query parameter to retrieve the next or previous page. Both forward and backward pagination are supported.

Authorization Scope

Only the merchant secret key is authorized to call this endpoint.


Path Params
string
required

The id of the merchant.

Query Params
int32

The maximum number of campaigns to return.

string

A cursor returned from a previous request to fetch the next or previous page.

string
enum

Pagination direction. Either "forward" or "backward"

Allowed:
string
enum

Campaign status filter

Allowed:
string
enum

Campaign type filter

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json