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

# Get campaign segments

`GET /api/v1/research/campaign-segments/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/research/campaign-segments/{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 the segment entries one Research campaign's active respondents hold: the customers themselves, audiences, channels, and stores, each an id and label. Pass { axis, id } entries as `segments` to research_results_get_v7 or research_conversations_list_v2 to narrow them.

## Path parameters

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

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- ResearchCampaignSegmentsGetResponse
  - `customers` object[], required: Entries on the `customer` axis: the campaign's customers, by name.
    - `id` string, required: The segment entry's id, as a segment scope names it.
    - `label` string, required
  - `audiences` object[], required: Entries on the `audience` axis.
    - `id` string, required: The segment entry's id, as a segment scope names it.
    - `label` string, required
  - `channels` object[], required: Entries on the `channel` axis.
    - `id` string, required: The segment entry's id, as a segment scope names it.
    - `label` string, required
  - `stores` object[], required: Entries on the `store` axis.
    - `id` string, required: The segment entry's id, as a segment scope names it.
    - `label` string, required

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