---
title: "Get a campaign"
method: GET
path: "/campaign/{id}"
tags: ["Campaigns"]
---

# Get a campaign

`GET /campaign/{id}`

Get a campaign with detailed metrics

## Path parameters

- `id` string, required

## Response `200`

Campaign details with metrics

- object
  - `status` boolean
  - `data` object
    - `campaign` object
      - `_id` string — The unique identifier for the campaign
      - `name` string — The name of the campaign
      - `description` string — The description of the campaign
      - `organization` string — The ID of the organization
      - `agent` object — The agent assigned to this campaign
        - `_id` string
        - `name` string
        - `workflowType` string
      - `audience` object — The audience assigned to this campaign
        - `_id` string
        - `name` string
      - `createdBy` string — The ID of the user who created the campaign
      - `participantsCount` integer — The number of participants in the campaign
      - `status` 'draft' | 'scheduled' | 'processing' | 'running' | 'paused' | 'completed' | 'failed' — The current status of the campaign
      - `maxRetries` integer — Maximum number of retry attempts
      - `retryDelay` integer — Delay between retries in minutes
      - `retryAttempts` integer — Total retry attempts made so far
      - `scheduledAt` string, date-time — Scheduled start time for the campaign
      - `pausedAt` string, date-time — When the campaign was paused
      - `cancelledCallsCount` integer — Number of calls cancelled (e.g. when campaign was paused)
      - `error` string — Error message if the campaign failed
      - `failedAt` string, date-time — When the campaign entered failed state
      - `createdAt` string, date-time — The date and time when the campaign was created
      - `updatedAt` string, date-time — The date and time when the campaign was last updated
    - `events` object[] — Campaign events history
      - `_id` string
      - `triggerSource` string
      - `eventAction` string
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
    - `metrics` object — Campaign performance metrics
      - `total_participants` integer — Total number of contacts in the campaign audience
      - `contacts_called` integer — Number of unique contacts where a call was attempted (statuses ACTIVE, COMPLETED, FAILED, NO_ANSWER)
      - `contacts_connected` integer — Number of unique contacts who answered and had a conversation (status COMPLETED)

## Other responses

- `400` — Invalid input
- `401` — Unauthorized access
- `500` — Internal server error

---

[API](https://skmtc.net/smallest-inc/apis/agent-management-api.md) · [All operations](https://skmtc.net/smallest-inc/apis/agent-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smallest-inc/agent-management-api/revisions/c2d0eb64b01a/schema)