List marketing campaigns (campagne)

Returns the authored campaigns, newest first, with its lifecycle status (draft, scheduled, sending, sent, failed) and the delivery counters recorded at its last dispatch. Page with page/pageSize (max 100) until page reaches pageCount. Use it to find a campaign id before a dry-run or a send.

GET /v1/campaigns

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "id": "cmp-3f8a1c02-9d41-4c7b-8b12-6a0f5d7e2c33",
      "name": "Soldes été 2026",
      "channel": "email",
      "segment": {
        "segment": "champions",
        "minMonetaryCents": 50000
      },
      "content": {
        "subject": "Vos soldes en avant-première",
        "body": "Profitez de -20% ce week-end."
      },
      "couponBatchRef": "SUMMER26",
      "status": "draft",
      "audienceCount": 0,
      "recipientCount": 0,
      "sentCount": 0,
      "failedCount": 0,
      "createdAt": "2026-07-28T09:00:00.000Z",
      "updatedAt": "2026-07-28T09:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 20,
  "pageCount": 1
}

Authorizations

Authorization · string · header · required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Query Parameters

page · integer · default: 1

1-based page index to return. Defaults to 1.

Required range: 1 <= x <= 9007199254740991

pageSize · integer · default: 20

Rows per page, 1..100. Defaults to 20.

Required range: 1 <= x <= 100

Response

200

application/json

A page of campaigns with their dispatch state, newest first.

A page of campaigns with their dispatch state, newest first.

items · object[] · required

The rows on this page, in the query's sort order.

Show child attributes

total · integer · required

Total rows matching the filter across ALL pages, not just this one.

Required range: 0 <= x <= 9007199254740991

page · integer · required

The 1-based page number served.

Required range: 0 < x <= 9007199254740991

pageSize · integer · required

Rows requested per page.

Required range: 0 < x <= 9007199254740991

pageCount · integer · required

Total number of pages; stop walking when page reaches it.

Required range: 0 <= x <= 9007199254740991