Get a campaign

One campaign plus `recipientCounts` — what actually happened to the list, which the campaign row alone cannot say. SKIPPED there is a normal outcome, not a failure: it means opted out, or no usable address for this channel, and it is the whole story of why a send reached fewer people than the audience count promised.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

campaigns:read

Path Parameters

Name	Type	Required	Description
`campaignId`	string	Required	Campaign ID.

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/campaigns/{campaignId}" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Campaign retrieved successfully!",
  "content": {
    "campaign": {
      "id": "cmp_3311",
      "locationId": "loc_abc123",
      "name": "Autumn service reminder",
      "channel": "EMAIL",
      "status": "DRAFT",
      "subject": "Time for your autumn service",
      "body": "Hi {{name}} — you are due for a service.",
      "audience": {
        "lifecycleStages": [
          "CUSTOMER"
        ],
        "inactiveDays": 180,
        "createdWithinDays": null,
        "neverContacted": false
      },
      "scheduledAt": null,
      "startedAt": null,
      "sentAt": null,
      "createdAt": "2026-08-26T12:00:00.000Z",
      "updatedAt": "2026-08-26T12:00:00.000Z"
    },
    "recipientCounts": {
      "SENT": 812,
      "DELIVERED": 790,
      "SKIPPED": 44,
      "FAILED": 3
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

xRM → Campaigns

/xrm/campaigns

Open a campaign from the list.