Campaigns
List Campaigns
List your campaigns, with customer counts for each one. Results come back one page at a time.
Authorization
x-api-key x-api-key<token>
API key required for authentication.
Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.
In: header
Query Parameters
number
GET /v2/campaigns Parameter
Default1Range1 <= value
number
GET /v2/campaigns Parameter
Default50Range1 <= value <= 100
string
Include the organization receptionist in configuration listings. Receptionists cannot be assigned sources.
Value in"true" | "false"
string
Field to sort by
Default"createdAt"Value in"createdAt" | "updatedAt" | "name" | "status" | "startDate" | "todayCalls"
string
Sort direction
Default"desc"Value in"asc" | "desc"
string
Search query for filtering campaigns by name or description
string
Filter campaigns by status
Value in"draft" | "active" | "paused" | "completed" | "archived" | "cancelled"
string
Filter by campaign kind. 'voice_ai' returns voice-AI campaigns (and legacy null-kind); 'agent_first' returns agent-first dialers/desks.
Value in"voice_ai" | "agent_first"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.carecycle.ai/v2/campaigns"{
"itemsTotal": 0,
"currentPage": 0,
"nextPage": 0,
"prevPage": 0,
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"configurationRevision": 9007199254740991,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"dialAfterhours": true,
"primaryVoicemailGreeting": "string",
"afterHoursVoicemailGreeting": "string",
"name": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"templateName": "string",
"lastModifiedByName": "string",
"lastModifiedByIsStaff": true,
"description": "string",
"tags": [],
"isReceptionist": true,
"isSample": true,
"callerIdSource": "client_main",
"status": "draft",
"direction": "inbound",
"pulseWorkflowId": "6cbf4411-f62a-452f-b47e-a87913280a83",
"maxConcurrentCalls": 1,
"vertical": "aca",
"kind": "voice_ai",
"dialerConfig": {
"voicemailMessage": "string",
"dialingRatio": 1
},
"compatibilityWarnings": [],
"smsCompanyName": "string",
"requiredVars": [],
"client": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"smsCompanyName": "string"
},
"hasInquiryCallback": true,
"customerStats": {
"total": 0,
"totalCalls": 0,
"todayCalls": 0,
"todayInboundCalls": 0,
"todayOutboundCalls": 0,
"todayConnectRate": 0,
"todayDurationMs": 0,
"statusCounts": {
"expired": 0,
"failed": 0,
"pending": 0,
"completed": 0,
"exceeded_max_calls": 0,
"in_progress": 0,
"cancelled": 0,
"skipped": 0
}
},
"transferConfig": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"name": "string",
"description": "string",
"configuration": {
"version": 2,
"destination": {
"type": "direct",
"phoneNumber": "string",
"externalHandoff": {
"mode": "cold"
}
},
"drafts": {
"direct": {
"type": "direct",
"phoneNumber": "string",
"externalHandoff": {
"mode": "cold"
}
},
"dynamic": {
"type": "dynamic",
"pingUrl": "string",
"method": "GET",
"timeout": 1,
"headers": {
"property1": "string",
"property2": "string"
},
"body": {
"property1": null,
"property2": null
},
"transferNumberField": "string",
"transferNumber": "string",
"successConditions": [
{
"field": "string",
"operator": "equals",
"value": "string"
}
],
"fallback": {
"type": "none"
},
"externalHandoff": {
"mode": "cold"
}
},
"sip": {
"type": "sip",
"uri": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"externalHandoff": {
"mode": "cold"
}
},
"softphone": {
"type": "softphone",
"routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
"handoffStrategy": "wait-for-operator",
"voiceAiFallback": {
"type": "none"
},
"agentWorkspace": {
"screenBehavior": "call-form",
"callFormId": "ce7b9bca-896d-440b-961b-042f5bf12d2d"
},
"agentFirstHandling": {
"inboundNoAgentAction": "unavailable_message",
"fallbackRoutingGroupId": "fc9bdd5d-620e-4760-a87c-7948228bfe46",
"callback": {
"offerEnabled": true,
"abandonOfferEnabled": true,
"aiOfferEnabled": true,
"expiryMinutes": 15,
"maxAttempts": 1,
"retryDelayMinutes": 1,
"closeBufferMinutes": 5
},
"primaryVoicemailGreeting": "string",
"afterHoursVoicemailGreeting": "string"
}
}
},
"warmTransfer": {
"mode": "wait-for-operator",
"summaryPrompt": "string"
}
},
"routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
"appointmentConfigId": "1c7d76df-b376-45c7-a6f4-7e4bd224ddc2",
"callFormId": "ce7b9bca-896d-440b-961b-042f5bf12d2d",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"usageHash": "string",
"usedByResources": [
{
"kind": "transfer",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"compatibilityWarnings": [],
"assignedCampaignCount": 0,
"usedByCampaigns": [
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string"
}
],
"usedByReceptionist": true,
"routingConfig": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
},
"transferConfigIds": [],
"callFormId": "ce7b9bca-896d-440b-961b-042f5bf12d2d",
"appointmentConfig": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"name": "string",
"description": "string",
"concurrentLimit": -2147483648,
"appointmentLength": -2147483648,
"appointmentSpacing": -2147483648,
"maxOptions": -2147483648,
"minDate": "2019-08-24",
"maxDate": "2019-08-24",
"minHours": -2147483648,
"preferredMode": "timezone",
"appointmentMode": "phone_call",
"showCallerIdOnBookingPage": true,
"assignmentMode": "customer_agent",
"routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
"transferConfigId": "e0ca1204-c276-46be-8cf8-5259ed04eb66",
"workflows": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"enabled": true,
"trigger": {
"anchor": "event_starts",
"offsetMinutes": -9007199254740991
},
"condition": {
"kind": "appointment_status",
"statuses": [
"scheduled"
]
},
"action": {
"type": "sms",
"senderId": "string",
"template": "string"
}
}
],
"bookingHours": [
{
"startHour": 23,
"startMinute": 59,
"endHour": 24,
"endMinute": 59,
"dayOfWeek": [
6
]
}
],
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
"usageHash": "string",
"usedByResources": [
{
"kind": "transfer",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"activeBookingLinkCount": 9007199254740991,
"upcomingAppointmentCount": 9007199254740991,
"usedByScenarios": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"readiness": {
"ready": true,
"issues": [
{
"section": "string",
"message": "string"
}
]
},
"assignedCampaignCount": 0,
"assignedTransferConfigCount": 0,
"usedByCampaigns": [
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string"
}
],
"usedByTransferConfigs": [
{
"id": "string",
"name": "string"
}
],
"usedByReceptionist": true
},
"campaignAutomations": []
}
]
}{
"message": "string",
"code": "string",
"details": {
"property1": null,
"property2": null
}
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string",
"details": {
"property1": null,
"property2": null
}
}{
"message": "string",
"code": "VALIDATION_ERROR",
"errors": [
{
"path": [
"string"
],
"message": "string",
"expected": "string",
"received": "string",
"code": "string"
}
],
"failedRecords": [
{
"index": 0,
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"externalId": "string"
}
]
}{
"message": "string",
"code": "string",
"retryAfter": 0
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}