Skip to main content
GET
/
v1
/
campaigns
/
{campaignId}
Get Campaign
curl --request GET \
  --url https://api.sigmamind.ai/v1/campaigns/{campaignId} \
  --header 'X-API-Key: <api-key>'
{
  "campaignId": "camp_XiQEBcj9cc5TFRB4",
  "campaignName": "Q4 Outreach Campaign",
  "campaignStatus": "live",
  "scheduledDate": "2025-09-25T19:00:00.000Z",
  "concurrentCalls": 5,
  "agent": {
    "name": "New AI Agent",
    "agentId": "agent_D5D0p7TUs66TTAEAx",
    "status": "Live"
  },
  "phoneNumber": {
    "sipPhoneNumber": "+14155552671",
    "provider": "twilio",
    "inboundAgentId": "agent_D5D0p7TUs66TTAEAx",
    "outboundAgentId": "agent_D5D0p7TUs66TTAEAx",
    "outboundPhoneNumber": "+14155552671",
    "active": true,
    "terminationSipURI": "sip.telnyx.com",
    "friendlyName": "Support Line - US"
  },
  "errors": [
    "Row 3: missing required variable 'customer_name'",
    "Row 7: invalid phone number '+1234'"
  ],
  "scheduled": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.sigmamind.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.

Path Parameters

​
campaignId
string
required

Unique identifier of the campaign to retrieve.

Response

OK

Full details of a campaign record. Includes the campaign's identity, current status, schedule configuration, the agent handling calls, and the caller phone number used to dial contacts.

​
campaignId
string

Unique identifier for this campaign. Use this value as campaignId when updating, deleting, or triggering this campaign via the API.

Example:

"camp_XiQEBcj9cc5TFRB4"

​
campaignName
string

Display name of this campaign as set at creation time. Used to identify the campaign in listings and dashboards.

Example:

"Q4 Outreach Campaign"

​
campaignStatus
enum<string>

Current lifecycle state of the campaign. 'live' means the campaign is actively dialling contacts. 'scheduled' means the campaign is configured to launch at a future date and time. 'paused' means dialling has been suspended and can be resumed. 'completed' means all contacts have been dialled and the campaign has finished.

Available options:
live,
scheduled,
paused,
completed
Example:

"live"

​
scheduledDate
string<date-time>

The date and time when this campaign is scheduled to launch, including timezone. Present only when isScheduled is true. Null for campaigns that started immediately at creation.

Example:

"2025-09-25T19:00:00.000Z"

​
concurrentCalls
integer<int32>

Maximum number of calls allowed to be active simultaneously in this campaign. Determines dialling throughput — higher values dial more contacts in parallel. Reflects the value set at creation or last updated via the update endpoint.

Example:

5

​
agent
object

Agent assigned to handle all calls in this campaign. Contains the agent's ID, name, and current status. All contacts in the campaign's contact list will be called using this agent.

​
phoneNumber
object

Caller phone number used to dial contacts in this campaign. This number appears as the caller ID on recipients' devices.

​
errors
string[]

List of validation errors encountered when processing the campaign's contact CSV file. Present only when the upload contained rows with invalid phone numbers or missing required variables. Null or empty when the file was processed without errors.

List of validation errors encountered when processing the campaign's contact CSV file. Present only when the upload contained rows with invalid phone numbers or missing required variables. Null or empty when the file was processed without errors.

Example:
[
  "Row 3: missing required variable 'customer_name'",
  "Row 7: invalid phone number '+1234'"
]
​
scheduled
boolean