---
title: "Get campaigns"
method: GET
path: "/api/v1/research/campaigns/{id}"
tags: ["research"]
---

# Get campaigns

`GET /api/v1/research/campaigns/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/research/campaigns/{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 one Research campaign by id, with how many distinct stores its active members are bound to (0 for a profile campaign).

## Path parameters

- `id` string, uuid, required: The campaign id from research.campaigns.list.v1.

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- ResearchCampaignsGetResponse
  - `id` string, uuid, required
  - `campaignKey` string, required: The campaign's route key.
  - `name` string, required
  - `study` 'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap' | 'purchasing' | 'competitors', required: The study the campaign runs.
  - `status` 'active' | 'paused' | 'archived' | 'deleted', required
  - `targetKind` 'profile' | 'physical_locations', required: The frozen cohort: the business profile's customers, or its physical stores.
  - `businessProfileId` string, uuid, nullable, required
  - `profileName` string, nullable, required: The launch profile's display name, else the campaign URL; null without a profile.
  - `createdAt` string, date-time, required
  - `locationCount` integer, required: A store campaign's distinct stores among its active members; 0 for a profile campaign.

## 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/5241805fe425?raw)
