List Campaigns
Paginated list of loyalty/cashback campaigns. Filter by name, trigger or type through the shared listing grammar. Returns the campaign setup, not its results — for cards generated, value distributed and redeemed, see the campaign report.
Every row carries a derived status: active, draft, paused or finished.
draft is a campaign saved but not published yet (isDraft): it never runs
and wins over every other status.
finished is not a column: for audience-list campaigns it means the send
is over (audience-status = finished); for every other trigger it means the
campaign period (finishAt) has ended. finished wins over isActive — a
campaign whose period ended but is still switched on comes back as
finished. The status is read-only: it never changes isActive.
Try-it values populated from environment ACME (Demo)
Authentication
Token
Send your user token in the x-guper-authorization header. Endpoints that
support a Public mode (e.g. acúmulo and resgate previews) accept the same
request without the header — Private mode adds customer data and a
confirmation token to the response.