---
title: "Get campaign settings (v3)"
method: GET
path: "/api/v1/research/campaign-settings-v3/{id}"
tags: ["research"]
deprecated: true
---

# Get campaign settings (v3)

`GET /api/v1/research/campaign-settings-v3/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/research/campaign-settings-v3/{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`)

> **Deprecated.**

Deprecated: use research.campaign-settings.get.v4 (research_campaign_settings_get_v4), which also names a study's customer assumptions; this version leaves them out, so a study that states some reads as a version 4 study without them. Get a Research campaign's saved study, targeting and schedule, active, paused or archived alike: the study, its description, its questions and the file or video each shows, the interviews each quota period takes, whom they reach, the competitors it compares with, and its schedule as campaigns_summaries_get_v2 names it. Its progress and standing are campaigns_summaries_get_v2's.

## Path parameters

- `id` string, uuid, required: The Research campaign id.

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- ResearchCampaignSettingsGetV3Response
  - `id` string, uuid, required
  - `businessProfileId` string, uuid, nullable, required: The business profile it runs on.
  - `subtype` 'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap' | 'purchasing' | 'competitors', required: The study it runs.
  - `targetKind` 'profile' | 'physical_locations', required: Whom it interviews: the profile's customers, or its stores' customers.
  - `targetInterviewCount` integer, required: The interviews each run takes.
  - `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 interviews; null for current customers.
  - `competitorSet` string[], required: The competitors it was set up to compare with.
  - `instrument` union, required: The study as saved: its questions and, for a study that shows something, what it shows. A study saved before the campaign spec carries its questions alone.
    - union
      - ResearchInstrument
        - `version` 'research-campaign-spec.v1', required
        - `playbookKey` 'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap', required
        - `templateSlug` string, required
        - `templateVersion` integer, required
        - `stimulus` union, required
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'brand', required
            - `title` string
            - `brand` string, required
            - `category` string
            - `competitors` string[], required
            - `startUrl` string, uri
            - `shownList` string[]
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'copy', required
            - `title` string
            - `copies` object[], required
              - …
          - ResearchStimulusVariant
            - `version` 'research-stimulus.v1', required
            - `kind` 'ads', required
            - `title` string
            - `format` 'full_ad' | 'headline' | 'tagline' | 'product_name' | 'email_subject' | 'social_post'
            - `placement` string
            - `ads` object[], required
              - …
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'concept', required
            - `title` string
            - `concepts` object[], required
              - …
          - ResearchStimulusVariant2
            - `version` 'research-stimulus.v1', required
            - `kind` 'offer_set', required
            - `title` string
            - `offers` object[], required
              - …
            - `category` string
            - `liveOffer` object
              - …
          - ResearchStimulusVariant3
            - `version` 'research-stimulus.v1', required
            - `kind` 'price_ladder', required
            - `title` string, required
            - `description` string
            - `currency` string, required
            - `billingUnit` 'one_time' | 'per_month' | 'per_year' | 'per_seat_per_month'
            - `prices` object[], required
              - …
            - `plannedPriceId` string
            - `category` string
            - `alternatives` object[]
              - …
            - `plans` string[]
            - `pricingPageUrl` string, uri
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'task', required
            - `title` string, required
            - `instructions` string, required
            - `destinationUrl` string, uri
            - `problem` string
            - `keyMessage` string
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'custom', required
            - `title` string
            - `content` string, required
            - `assetRefs` string[]
            - `private` true
          - ResearchStimulusVariant4
            - `version` 'research-stimulus.v1', required
            - `kind` 'features', required
            - `title` string
            - `job` string, required
            - `productName` string, required
            - `features` object[], required
              - …
            - `productTask` object
              - …
        - `questions` union[], required
          - union
            - object
              - …
            - object
              - …
        - `resultContract` object, required
          - `version` 'research-result-contract.v1', required
          - `observationKinds` string[], required
        - `scorer` object, required
          - `id` string, required
          - `version` integer, required
      - ResearchInstrument2
        - `version` 'research-campaign-spec.v2', required
        - `playbookKey` 'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap', required
        - `templateSlug` string, required
        - `templateVersion` integer, required
        - `stimulus` union, required
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'brand', required
            - `title` string
            - `brand` string, required
            - `category` string
            - `competitors` string[], required
            - `startUrl` string, uri
            - `shownList` string[]
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'copy', required
            - `title` string
            - `copies` object[], required
              - …
          - ResearchStimulusVariant
            - `version` 'research-stimulus.v1', required
            - `kind` 'ads', required
            - `title` string
            - `format` 'full_ad' | 'headline' | 'tagline' | 'product_name' | 'email_subject' | 'social_post'
            - `placement` string
            - `ads` object[], required
              - …
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'concept', required
            - `title` string
            - `concepts` object[], required
              - …
          - ResearchStimulusVariant2
            - `version` 'research-stimulus.v1', required
            - `kind` 'offer_set', required
            - `title` string
            - `offers` object[], required
              - …
            - `category` string
            - `liveOffer` object
              - …
          - ResearchStimulusVariant3
            - `version` 'research-stimulus.v1', required
            - `kind` 'price_ladder', required
            - `title` string, required
            - `description` string
            - `currency` string, required
            - `billingUnit` 'one_time' | 'per_month' | 'per_year' | 'per_seat_per_month'
            - `prices` object[], required
              - …
            - `plannedPriceId` string
            - `category` string
            - `alternatives` object[]
              - …
            - `plans` string[]
            - `pricingPageUrl` string, uri
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'task', required
            - `title` string, required
            - `instructions` string, required
            - `destinationUrl` string, uri
            - `problem` string
            - `keyMessage` string
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'custom', required
            - `title` string
            - `content` string, required
            - `assetRefs` string[]
            - `private` true
          - ResearchStimulusVariant4
            - `version` 'research-stimulus.v1', required
            - `kind` 'features', required
            - `title` string
            - `job` string, required
            - `productName` string, required
            - `features` object[], required
              - …
            - `productTask` object
              - …
        - `questions` ResearchQuestionsItem2[], required
          - union
            - object
              - …
            - object
              - …
        - `resultContract` object, required
          - `version` 'research-result-contract.v1', required
          - `observationKinds` string[], required
        - `scorer` object, required
          - `id` string, required
          - `version` integer, required
      - ResearchInstrument3
        - `version` 'research-campaign-spec.v3', required
        - `playbookKey` 'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap', required
        - `templateSlug` string, required
        - `templateVersion` integer, required
        - `stimulus` union, required
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'brand', required
            - `title` string
            - `brand` string, required
            - `category` string
            - `competitors` string[], required
            - `startUrl` string, uri
            - `shownList` string[]
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'copy', required
            - `title` string
            - `copies` object[], required
              - …
          - ResearchStimulusVariant
            - `version` 'research-stimulus.v1', required
            - `kind` 'ads', required
            - `title` string
            - `format` 'full_ad' | 'headline' | 'tagline' | 'product_name' | 'email_subject' | 'social_post'
            - `placement` string
            - `ads` object[], required
              - …
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'concept', required
            - `title` string
            - `concepts` object[], required
              - …
          - ResearchStimulusVariant2
            - `version` 'research-stimulus.v1', required
            - `kind` 'offer_set', required
            - `title` string
            - `offers` object[], required
              - …
            - `category` string
            - `liveOffer` object
              - …
          - ResearchStimulusVariant3
            - `version` 'research-stimulus.v1', required
            - `kind` 'price_ladder', required
            - `title` string, required
            - `description` string
            - `currency` string, required
            - `billingUnit` 'one_time' | 'per_month' | 'per_year' | 'per_seat_per_month'
            - `prices` object[], required
              - …
            - `plannedPriceId` string
            - `category` string
            - `alternatives` object[]
              - …
            - `plans` string[]
            - `pricingPageUrl` string, uri
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'task', required
            - `title` string, required
            - `instructions` string, required
            - `destinationUrl` string, uri
            - `problem` string
            - `keyMessage` string
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'custom', required
            - `title` string
            - `content` string, required
            - `assetRefs` string[]
            - `private` true
          - ResearchStimulusVariant4
            - `version` 'research-stimulus.v1', required
            - `kind` 'features', required
            - `title` string
            - `job` string, required
            - `productName` string, required
            - `features` object[], required
              - …
            - `productTask` object
              - …
        - `questions` union[], required
          - union
            - union
              - …
            - object
              - …
        - `resultContract` object, required
          - `version` 'research-result-contract.v1', required
          - `observationKinds` string[], required
        - `scorer` object, required
          - `id` string, required
          - `version` integer, required
      - ResearchInstrument4
        - `version` 'research-campaign-spec.v4', required
        - `playbookKey` 'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap', required
        - `templateSlug` string, required
        - `templateVersion` integer, required
        - `stimulus` union, required
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'brand', required
            - `title` string
            - `brand` string, required
            - `category` string
            - `competitors` string[], required
            - `startUrl` string, uri
            - `shownList` string[]
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'copy', required
            - `title` string
            - `copies` object[], required
              - …
          - ResearchStimulusVariant
            - `version` 'research-stimulus.v1', required
            - `kind` 'ads', required
            - `title` string
            - `format` 'full_ad' | 'headline' | 'tagline' | 'product_name' | 'email_subject' | 'social_post'
            - `placement` string
            - `ads` object[], required
              - …
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'concept', required
            - `title` string
            - `concepts` object[], required
              - …
          - ResearchStimulusVariant2
            - `version` 'research-stimulus.v1', required
            - `kind` 'offer_set', required
            - `title` string
            - `offers` object[], required
              - …
            - `category` string
            - `liveOffer` object
              - …
          - ResearchStimulusVariant3
            - `version` 'research-stimulus.v1', required
            - `kind` 'price_ladder', required
            - `title` string, required
            - `description` string
            - `currency` string, required
            - `billingUnit` 'one_time' | 'per_month' | 'per_year' | 'per_seat_per_month'
            - `prices` object[], required
              - …
            - `plannedPriceId` string
            - `category` string
            - `alternatives` object[]
              - …
            - `plans` string[]
            - `pricingPageUrl` string, uri
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'task', required
            - `title` string, required
            - `instructions` string, required
            - `destinationUrl` string, uri
            - `problem` string
            - `keyMessage` string
          - object
            - `version` 'research-stimulus.v1', required
            - `kind` 'custom', required
            - `title` string
            - `content` string, required
            - `assetRefs` string[]
            - `private` true
          - ResearchStimulusVariant4
            - `version` 'research-stimulus.v1', required
            - `kind` 'features', required
            - `title` string
            - `job` string, required
            - `productName` string, required
            - `features` object[], required
              - …
            - `productTask` object
              - …
        - `questions` ResearchItem[], required
          - union
            - object
              - …
            - object
              - …
            - ResearchItemVariant
              - …
        - `resultContract` object, required
          - `version` 'research-result-contract.v1', required
          - `observationKinds` string[], required
        - `scorer` object, required
          - `id` string, required
          - `version` integer, required
        - `presentationOrder` 'per_participant'
    - ResearchInstrument5
      - `subtype` 'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap' | 'purchasing' | 'competitors', required
      - `templateSlug` string, required
      - `templateVersion` integer, required
      - `questions` object[], required
        - `id` string, required
        - `title` string, required
        - `prompt` string, required
        - `shape` 'open_ended' | 'closed_ended' | 'rank' | 'matrix' | 'scale', required
        - `options` string[]
        - `gate` object
          - `id` string, required
          - `readQuestionId` string, required
          - `branches` object[], required
            - `when` string, required
            - `nextQuestionId` string, required
  - `settingsRevision` integer, required: Its settings revision: pass it as expectedSettingsRevision to research.campaign-settings-quotes.get and research.campaign-settings.update.
  - `locks` object, required: The settings research.campaign-settings.update cannot change on this campaign, each with why; a setting absent here changes.
    - `targetInterviewCount` string
    - `audience` string
    - `frequency` string
    - `study` string

## 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)