> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sequenzy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an In-App Campaign

> Get an in-app campaign and its results

Returns an in-app campaign's message, audience, priority, schedule, end time and state. Once the campaign has launched, `stats` holds its reach and engagement (see [In-App Campaign Stats](https://docs.sequenzy.com/api-reference/in-app/campaign-stats.md)); it is `null` for drafts and scheduled campaigns. Requires the `campaigns:read` scope.

## Request

**campaignId** `string` *required*

The in-app campaign ID.

```bash theme={null}
curl -X GET "https://api.sequenzy.com/api/v1/in-app/campaigns/cmp_abc123" \
  --header "Authorization: Bearer $SEQUENZY_API_KEY"
```

## Responses

```json 200 theme={null}
{
  "success": true,
  "campaign": {
    "id": "cmp_abc123",
    "name": "New dashboards",
    "type": "in_app",
    "status": "sent",
    "state": "live",
    "message": {
      "label": "",
      "kind": "message",
      "format": "modal",
      "title": "Hi {{firstName}}, dashboards are here",
      "body": "See every campaign at a glance.",
      "buttons": [
        {
          "label": "Take a look",
          "action": "open_url",
          "url": "myapp://dashboards"
        }
      ]
    },
    "priority": "high",
    "endsAt": "2026-12-01T00:00:00.000Z",
    "targetLists": {
      "type": "segment",
      "segmentId": "seg_123"
    },
    "scheduledAt": null,
    "sentAt": "2026-11-08T09:00:00.000Z",
    "estimatedRecipientCount": 1200,
    "labelIds": [],
    "createdAt": "2026-11-07T12:00:00.000Z",
    "updatedAt": "2026-11-08T09:00:00.000Z"
  },
  "stats": {
    "delivered": 860,
    "displayed": 812,
    "clicked": 214,
    "totalClicks": 251,
    "dismissed": 402,
    "pushPermissionGranted": 0,
    "pushPermissionDenied": 0,
    "buttons": []
  }
}
```

```json 401 theme={null}
{
  "error": "Invalid API key"
}
```

```json 403 theme={null}
{
  "error": "API key is missing required scope: campaigns:read"
}
```

```json 404 theme={null}
{
  "error": "Campaign not found."
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.