---
title: "Get Campaign"
method: GET
path: "/v2/campaigns/{campaignId}"
---

# Get Campaign

`GET /v2/campaigns/{campaignId}`

## Request

- Base URL: `https://pub-api.conversion.ai/api`
- URL: `https://pub-api.conversion.ai/api/v2/campaigns/{campaignId}`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`

Get a custom campaign by id, including its description and its campaign type's member statuses as `type.statuses`. Statuses are returned in the type's configured progression order. Archived campaigns return 404.

## Path parameters

- `campaignId` string, uuid, required

## Response `200`

Campaign retrieved successfully.

- object
  - `data` object
    - `campaign` object, required
      - `id` string, uuid, required: The Conversion campaign id.
      - `name` string, required: The campaign's display name, unique within the workspace.
      - `type` object, required: The campaign type the campaign belongs to. Types are defined in the dashboard.
        - `id` string, uuid, required: The campaign type id.
        - `name` string, required: The type's display name, as configured in the dashboard.
        - `systemType` 'CUSTOM', required: The system classification of the campaign type. Currently `CUSTOM`.
        - `statuses` object[], required: The member statuses configured for the campaign type, in progression order. Use a status's `id` or `name` as `statusId` or `status` when adding members.
          - `id` string, uuid, required: The campaign status id.
          - `name` string, required: The status's display name.
          - `isSuccess` boolean, required: Whether the status counts as a successful outcome for the campaign.
      - `sfdcCampaignId` string, nullable, required: The id of the Salesforce campaign this campaign is linked to, or `null` if the campaign is not linked to Salesforce.
      - `memberCount` integer, required: The total number of members in the campaign.
      - `createdAt` string, date-time, required: When the campaign was created.
      - `updatedAt` string, date-time, required: When the campaign was last updated.
      - `description` string, nullable, required: The campaign's description, or `null` if not set.

## Other responses

- `401`: Authentication failed.
- `404`: The requested resource was not found.
- `500`: An unexpected server error occurred.

---

[API](https://skmtc.dev/conversion/apis/conversion-api.md) - [All operations](https://skmtc.dev/conversion/apis/conversion-api/llms.txt) - [OpenAPI document](https://skmtc.dev/conversion/apis/conversion-api/revisions/8422f815402a?raw)