---
title: "Get campaign settings"
method: GET
path: "/api/v1/experience/campaign-settings/{id}"
tags: ["experience"]
---

# Get campaign settings

`GET /api/v1/experience/campaign-settings/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/experience/campaign-settings/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Get an Experience campaign's saved setup, active, paused or archived alike: its targets (starting pages, signed-in access, apps), devices, objective, customers, the Discovery campaign a Pulse mirrors, a campaign follows for its customers or reads its customers' direct competitors from, and customerVersions, which always answers latest: every new cycle uses each customer's newest version. Its schedule, progress and standing are campaigns_summaries_get_v2's.

## Path parameters

- `id` string, uuid, required: The Experience campaign's id

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- ExperienceCampaignSettingsGetResponse
  - `id` string, uuid, required
  - `businessProfileId` string, uuid, required: The business profile it runs on.
  - `mode` 'pulse' | 'burst', required: A Burst runs its own customers; a Pulse mirrors a Discovery campaign.
  - `targetSummary` object, required: The platforms and access its targets cover.
    - `platforms` string[], required
    - `accessModes` string[], required
  - `browserDevices` string[], required: The devices a browser uses.
  - `agents` string[], required: The agents each next cycle shops with, every one on every customer, page and device; point11 is Point11's own shopper, every other agent runs its vendor's model in Point11's browser.
  - `destinations` object[], required: The targets a Burst froze at launch: starting pages, signed-in access, apps.
    - `startUrl` string, nullable, required
    - `connectionAccess` object, nullable, required
      - `connection` object, required
        - `connectionId` string, uuid, required
        - `revision` integer, required
      - `account` object
        - `accountId` string, uuid, required
        - `revision` integer, required
    - `nativeApp` object, nullable, required
      - `platform` 'ios' | 'android', required
      - `buildId` string, uuid, required
      - `sha256` string, required
      - `appId` string, required
      - `versionLabel` string, required
      - `deviceName` string, required
      - `osVersion` string, required
  - `objective` string, nullable, required: What each customer sets out to do.
  - `targetedGroupIds` string[], nullable, required: The audiences it was targeted at; null when not narrowed to audiences.
  - `targetedCustomerIds` string[], nullable, required: The customers it was picked from; null when not hand-picked.
  - `targetedForecastId` string, uuid, nullable, required: The forecast whose customers it runs; null for current customers.
  - `customerCount` integer, required: The customers a Burst froze at launch.
  - `customerIds` string[], nullable, required: An always-on Burst's customer list: the customers its next cycles visit. Null where a Save cannot change the customers: a one-time Burst, one still on the retired weekly or monthly schedule, or a Pulse.
  - `sourceCampaignId` string, uuid, nullable, required: The Discovery campaign a Pulse mirrors.
  - `sourceCampaignName` string, nullable, required
  - `competitorSourceCampaignId` string, uuid, nullable, required: The Discovery campaign, on the same business profile, whose conversations name each customer's direct competitors, which every cycle shops beside the pages; set at launch, never by a Save. Null when the campaign shops its pages alone, and on a Pulse.
  - `competitorSourceCampaignName` string, nullable, required
  - `followedCampaignId` string, uuid, nullable, required: The Discovery campaign a Burst follows for its customers: each scheduled cycle it plans re-reads that campaign's roster, so a customer who left it leaves, each store the list no longer covers lends its share up to 100, and a Save changes no customers. Set at launch, never by a Save. Null when the campaign records no follow.
  - `followedCampaignName` string, nullable, required
  - `followedCampaignStatus` 'active' | 'paused' | 'archived' | 'deleted', nullable, required: The followed campaign's lifecycle. While it is archived the Burst keeps the customer list it last read, and a restore resumes the follow at the next scheduled cycle; once it is deleted the list stays for good.
  - `pulseCompetitors` boolean, nullable, required: Whether a Pulse also shops the competitors Discovery showed each customer; null for a Burst.
  - `pulseSampleEvery` integer, nullable, required: A Pulse mirrors 1 in this many of each source dispatch's Discovery conversations; 1 is every one. Null for a Burst.
  - `customerVersions` object, nullable, required: Which customer versions its next cycles use: each customer's newest, at every new cycle, while running work keeps its version. Null for a Burst that plans no next cycle: a one-time one, or one still on the retired weekly or monthly schedule.
    - `policy` 'pinned' | 'latest', required: Always latest: every new cycle uses each customer's newest version. pinned is no longer a choice.
    - `locked` 'pulse_follows_discovery', nullable, required: Always null: there is no policy left to change.
    - `newerCustomerCount` integer, required: Always 0: no customer has a newer version than the one its next cycle uses.
  - `settingsRevision` integer, required: Its settings revision: pass it as expectedSettingsRevision to experience.campaign-settings-quotes.get and experience.campaign-settings.update.

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)