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

# Get campaign

`GET /campaign/{campaignId}`

## Request

- Base URL: `https://app.freyavoice.ai/api/v2`
- URL: `https://app.freyavoice.ai/api/v2/campaign/{campaignId}`
- Auth: HTTP bearer

Returns campaign configuration, customers, events, and call IDs.

## Path parameters

- `campaignId` string, uuid, required: Campaign ID

## Query parameters

- `workspaceId` string, uuid, required: Workspace ID

## Response `200`

Campaign details

- object
  - `success` true, required
  - `data` object, required
    - `message` string, required
    - `result` CampaignDetailsResponse, required
      - `campaign` Campaign, required
        - `id` string, required
        - `assistantId` string, nullable
        - `phoneNumberId` string, nullable
        - `name` string, required
        - `description` string, nullable
        - `status` 'draft' | 'scheduled' | 'active' | 'completed' | 'partially_completed'
        - `startDate` string, date, nullable: When campaign starts (YYYY-MM-DD)
        - `startTime` string, nullable: Time on start date + retry window start (HH:MM)
        - `timezone` string: IANA timezone for all times
        - `endTime` string, nullable: Daily retry window end (HH:MM)
        - `activeDays` integer[]: Days retries can happen (0=Monday, 6=Sunday)
        - `phoneNumber` string, nullable
        - `callRetries` integer
        - `retryDelaySeconds` integer: Delay between retries in seconds
        - `retryDelayMode` 'fixed' | 'next_day'
        - `retryConditions` string[]: Array of call outcome values to retry on (SipCodeCategory + special endedReason values)
        - `endDate` string, date, nullable: @deprecated - No longer used
        - `schedulingMode` 'even' | 'fixed': @deprecated - No longer used
        - `callIntervalSeconds` integer: @deprecated - No longer used
        - `maxConcurrency` integer: Internal parameter (hardcoded to 5)
        - `webhookUrl` string, nullable
        - `customers` CampaignCustomer[]
          - `phoneNumber` string, required
          - `properties` object, nullable: Custom properties to pass to the agent
        - `callIds` string[]
        - `roomNames` string[]
        - `events` CampaignEvent[]
          - `event` string, required
          - `timestamp` string, date-time, required
          - `metadata` object, required
          - `message` string, required
          - `data` unknown
        - `version` 'v1' | 'v2'
        - `workspaceId` string, required
        - `createdAt` string, required
        - `updatedAt` string, required

## Other responses

- `400`: Validation error
- `401`: Missing or invalid token
- `404`: Campaign not found
- `500`: Server error

---

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