Loyalty

List campaigns

List wallet marketing campaigns of the application, with pagination, status filtering and sorting.

get/v1/loyalty/campaigns

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/loyalty/campaigns
  • Auth: API key in header X-Api-Key

Query parameters

field'id' | 'createdAt' | 'updatedAt' | 'name' | 'sendAt' required
order'asc' | 'desc' required
currentPageinteger

1-based page index.

pageSizeinteger

Number of items per page.

Response

Campaigns retrieved successfully

totalinteger required

Total count of items matching the query

Example response

{
  "data": [
    {
      "application": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Summer menu launch",
      "description": "Promote the new summer menu to recent visitors.",
      "channels": [
        "google",
        "apple"
      ],
      "targeting": {
        "minPoints": 100,
        "maxPoints": 500,
        "minVisits": 3,
        "rewardTierIds": [
          "550e8400-e29b-41d4-a716-446655440000"
        ]
      },
      "content": {
        "header": "New summer menu",
        "body": "Come and taste our new summer menu this week."
      },
      "sendAt": "2026-06-23T10:00:00Z",
      "status": "draft",
      "audienceSnapshotCount": 1234,
      "conversionWindowDays": 7,
      "sentAt": "2026-06-15T14:30:00Z",
      "scheduledImmediately": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.