Skip to main content
GET
/
v1
/
campaigns
List Campaigns
curl --request GET \
  --url https://api.sigmamind.ai/v1/campaigns \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "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
    }
  ],
  "page": 0,
  "size": 20,
  "totalCount": 125,
  "totalPages": 7,
  "hasNext": true,
  "hasPrevious": false
}

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.

Query Parameters

​
status
string

Filter campaigns by their current lifecycle state. Accepted values: 'live', 'scheduled', 'paused', 'completed'. Omit to return campaigns in all states.

​
page
integer<int32>
default:0

Zero-based page number to retrieve. Use 0 for the first page. Must be 0 or greater.

​
size
integer<int32>
default:10

Number of campaigns to return per page. Must be 1 or greater. Defaults to 10.

Response

OK

Standard wrapper for paginated API responses. Use this when returning list data that is split across multiple pages. Includes the current page of results along with pagination metadata to help clients navigate through large datasets efficiently.

​
data
object[]

List of items for the current page. Contains up to 'size' number of records.

​
page
integer<int32>

Current page number (0-based index). Indicates which page of results is being returned.

Example:

0

​
size
integer<int32>

Number of items requested per page. Determines the maximum size of the 'data' list.

Example:

20

​
totalCount
integer<int64>

Total number of records available across all pages. Useful for calculating pagination on the client side.

Example:

125

​
totalPages
integer<int32>

Total number of pages available based on totalCounts and size. Helps clients understand how many pages exist in total.

Example:

7

​
hasNext
boolean

Indicates whether there is a next page available after the current one. Useful for implementing 'Load More' or next navigation.

Example:

true

​
hasPrevious
boolean

Indicates whether there is a previous page before the current one. Useful for enabling backward navigation.

Example:

false