curl --request GET \
--url https://api.carecycle.ai/v2/campaigns \
--header 'x-api-key: <api-key>'{
"itemsTotal": 123,
"currentPage": 123,
"nextPage": 123,
"prevPage": 123,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"dialAfterhours": true,
"outboundEnabled": true,
"outboundBatchSize": 0,
"variableMappings": {},
"redialTracking": {
"lastRunSmsCount": 123,
"lastRunTimestamp": "2023-11-07T05:31:56Z"
},
"name": "<string>",
"type": "<string>",
"description": "<string>",
"status": "draft",
"sourceType": "<string>",
"suitType": "sales",
"redial": true,
"redialPatterns": [
{
"days": [
4503599627370495
],
"attempts": 2,
"intervalMinutes": 123
}
],
"successCriteria": {
"operator": "<string>",
"conditions": [
{
"field": "<string>",
"operator": "<string>",
"value": true
}
]
},
"failureCriteria": {
"operator": "<string>",
"conditions": [
{
"field": "<string>",
"operator": "<string>",
"value": true
}
]
},
"maxAttempts": 0,
"smsTypes": {
"redial": false,
"newInquiry": false,
"postWelcome": false,
"firstContact": false,
"missedInquiry": false,
"appointmentBooked": false,
"missedAppointment": false,
"missedFirstContact": false,
"appointmentReminder": false,
"informationalFollowup": false
},
"smsContent": {
"redial": "Hi {{clientCustomer.firstName}}, we tried to reach you but couldn''t connect. We''ll try again soon.",
"newInquiry": "Hi {{clientCustomer.firstName}}, we''ve received your inquiry. Our team will be reaching out to you shortly to address your questions about {{inquiryTopic}}.",
"postWelcome": "Hi {{clientCustomer.firstName}}, thank you for speaking with us today. If you need assistance, please contact us at {{companyPhone}}. We''re here to provide always-on care for you.",
"firstContact": "Hi {{clientCustomer.firstName}}, we''ll be calling you shortly regarding your inquiry.",
"missedInquiry": "Hi {{clientCustomer.firstName}}, we tried to reach you regarding your inquiry but couldn''t connect. Please contact us back at your earliest convenience.",
"appointmentBooked": "Hi {{clientCustomer.firstName}}, your appointment is confirmed for {{appointmentDate}} at {{appointmentTime}}.",
"missedAppointment": "Hi {{clientCustomer.firstName}}, we missed you at your appointment on {{appointmentDate}} at {{appointmentTime}}. Please contact us to reschedule.",
"missedFirstContact": "Hi {{clientCustomer.firstName}}, we tried to reach you but couldn''t connect. We''ll try again soon.",
"appointmentReminder": "Hi {{clientCustomer.firstName}}, this is a reminder about your upcoming appointment on {{appointmentDate}} at {{appointmentTime}}.",
"informationalFollowup": "Hi {{clientCustomer.firstName}}, it was a pleasure speaking to you. Questions or concerns? Feel free to call us: +1 xxx-xxx-xxxx."
},
"smsCompanyName": "<string>",
"client": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"smsCompanyName": "<string>"
},
"hasInquiryCallback": true,
"customerStats": {
"total": 123,
"totalCalls": 123,
"todayCalls": 123,
"statusCounts": {
"expired": 123,
"failed": 123,
"pending": 123,
"completed": 123,
"exceeded_max_calls": 123,
"in_progress": 123,
"cancelled": 123,
"skipped": 123
}
},
"transferConfig": {
"enabled": true,
"type": "direct",
"warmTransfer": true,
"destination": {
"phoneNumber": "<string>",
"pingUrl": "<string>",
"method": "GET",
"headers": {},
"body": {},
"timeout": 123,
"sipUri": "<string>",
"sipHeaders": {}
},
"warmTransferConfig": {
"summaryPrompt": "<string>",
"mode": "wait-for-operator"
},
"dynamicResponseConfig": {
"successConditions": [
{
"field": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"transferNumberField": "<string>",
"transferNumber": "<string>"
},
"softphoneFallback": {
"type": "appointment_booking",
"phoneNumber": "<string>",
"customMessage": "<string>"
},
"appointmentBooking": {
"enabled": true,
"customMessage": "<string>",
"transferWaitingMessages": {
"1": "<string>",
"2": "<string>",
"3": "<string>"
}
}
},
"appointmentConfig": {
"concurrentLimit": 123,
"appointmentLength": 123,
"appointmentSpacing": 247.5,
"maxOptions": 3,
"preferredMode": "zipcode",
"minDate": "<string>",
"maxDate": "<string>",
"minHours": 123,
"customMessage": "<string>"
},
"policyFilterConfig": {
"enabled": true,
"eligiblePolicyTypes": [
"MA"
],
"validStatuses": [
"Active"
]
},
"routingConfig": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"name": "<string>",
"description": "<string>",
"routingType": "linear",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fallbackBehavior": "voicemail",
"fallbackNumber": "<string>",
"maxRingPerAgent": -1,
"maxWaitTime": -1,
"tryCustomerAgentFirst": true,
"tryPreviousSoftphoneAgentFirst": true,
"customerAgentPriority": -1,
"previousSoftphoneAgentPriority": -1,
"agents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"routingConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"memberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priority": -1,
"weight": -1,
"lastCallAt": "<unknown>",
"isActive": true,
"skills": "<string>",
"member": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>",
"filterData": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "[email protected]"
}
}
}
],
"groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"routingConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"routingType": "linear",
"priority": -1,
"isActive": true,
"agents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"routingConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"memberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priority": -1,
"weight": -1,
"lastCallAt": "<unknown>",
"isActive": true,
"skills": "<string>",
"member": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>",
"filterData": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "[email protected]"
}
}
}
]
}
]
}
}
]
}Get paginated campaigns for the authenticated client with customer statistics
curl --request GET \
--url https://api.carecycle.ai/v2/campaigns \
--header 'x-api-key: <api-key>'{
"itemsTotal": 123,
"currentPage": 123,
"nextPage": 123,
"prevPage": 123,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"dialAfterhours": true,
"outboundEnabled": true,
"outboundBatchSize": 0,
"variableMappings": {},
"redialTracking": {
"lastRunSmsCount": 123,
"lastRunTimestamp": "2023-11-07T05:31:56Z"
},
"name": "<string>",
"type": "<string>",
"description": "<string>",
"status": "draft",
"sourceType": "<string>",
"suitType": "sales",
"redial": true,
"redialPatterns": [
{
"days": [
4503599627370495
],
"attempts": 2,
"intervalMinutes": 123
}
],
"successCriteria": {
"operator": "<string>",
"conditions": [
{
"field": "<string>",
"operator": "<string>",
"value": true
}
]
},
"failureCriteria": {
"operator": "<string>",
"conditions": [
{
"field": "<string>",
"operator": "<string>",
"value": true
}
]
},
"maxAttempts": 0,
"smsTypes": {
"redial": false,
"newInquiry": false,
"postWelcome": false,
"firstContact": false,
"missedInquiry": false,
"appointmentBooked": false,
"missedAppointment": false,
"missedFirstContact": false,
"appointmentReminder": false,
"informationalFollowup": false
},
"smsContent": {
"redial": "Hi {{clientCustomer.firstName}}, we tried to reach you but couldn''t connect. We''ll try again soon.",
"newInquiry": "Hi {{clientCustomer.firstName}}, we''ve received your inquiry. Our team will be reaching out to you shortly to address your questions about {{inquiryTopic}}.",
"postWelcome": "Hi {{clientCustomer.firstName}}, thank you for speaking with us today. If you need assistance, please contact us at {{companyPhone}}. We''re here to provide always-on care for you.",
"firstContact": "Hi {{clientCustomer.firstName}}, we''ll be calling you shortly regarding your inquiry.",
"missedInquiry": "Hi {{clientCustomer.firstName}}, we tried to reach you regarding your inquiry but couldn''t connect. Please contact us back at your earliest convenience.",
"appointmentBooked": "Hi {{clientCustomer.firstName}}, your appointment is confirmed for {{appointmentDate}} at {{appointmentTime}}.",
"missedAppointment": "Hi {{clientCustomer.firstName}}, we missed you at your appointment on {{appointmentDate}} at {{appointmentTime}}. Please contact us to reschedule.",
"missedFirstContact": "Hi {{clientCustomer.firstName}}, we tried to reach you but couldn''t connect. We''ll try again soon.",
"appointmentReminder": "Hi {{clientCustomer.firstName}}, this is a reminder about your upcoming appointment on {{appointmentDate}} at {{appointmentTime}}.",
"informationalFollowup": "Hi {{clientCustomer.firstName}}, it was a pleasure speaking to you. Questions or concerns? Feel free to call us: +1 xxx-xxx-xxxx."
},
"smsCompanyName": "<string>",
"client": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"smsCompanyName": "<string>"
},
"hasInquiryCallback": true,
"customerStats": {
"total": 123,
"totalCalls": 123,
"todayCalls": 123,
"statusCounts": {
"expired": 123,
"failed": 123,
"pending": 123,
"completed": 123,
"exceeded_max_calls": 123,
"in_progress": 123,
"cancelled": 123,
"skipped": 123
}
},
"transferConfig": {
"enabled": true,
"type": "direct",
"warmTransfer": true,
"destination": {
"phoneNumber": "<string>",
"pingUrl": "<string>",
"method": "GET",
"headers": {},
"body": {},
"timeout": 123,
"sipUri": "<string>",
"sipHeaders": {}
},
"warmTransferConfig": {
"summaryPrompt": "<string>",
"mode": "wait-for-operator"
},
"dynamicResponseConfig": {
"successConditions": [
{
"field": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"transferNumberField": "<string>",
"transferNumber": "<string>"
},
"softphoneFallback": {
"type": "appointment_booking",
"phoneNumber": "<string>",
"customMessage": "<string>"
},
"appointmentBooking": {
"enabled": true,
"customMessage": "<string>",
"transferWaitingMessages": {
"1": "<string>",
"2": "<string>",
"3": "<string>"
}
}
},
"appointmentConfig": {
"concurrentLimit": 123,
"appointmentLength": 123,
"appointmentSpacing": 247.5,
"maxOptions": 3,
"preferredMode": "zipcode",
"minDate": "<string>",
"maxDate": "<string>",
"minHours": 123,
"customMessage": "<string>"
},
"policyFilterConfig": {
"enabled": true,
"eligiblePolicyTypes": [
"MA"
],
"validStatuses": [
"Active"
]
},
"routingConfig": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"name": "<string>",
"description": "<string>",
"routingType": "linear",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fallbackBehavior": "voicemail",
"fallbackNumber": "<string>",
"maxRingPerAgent": -1,
"maxWaitTime": -1,
"tryCustomerAgentFirst": true,
"tryPreviousSoftphoneAgentFirst": true,
"customerAgentPriority": -1,
"previousSoftphoneAgentPriority": -1,
"agents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"routingConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"memberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priority": -1,
"weight": -1,
"lastCallAt": "<unknown>",
"isActive": true,
"skills": "<string>",
"member": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>",
"filterData": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "[email protected]"
}
}
}
],
"groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"routingConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"routingType": "linear",
"priority": -1,
"isActive": true,
"agents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"routingConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"memberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priority": -1,
"weight": -1,
"lastCallAt": "<unknown>",
"isActive": true,
"skills": "<string>",
"member": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<unknown>",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>",
"filterData": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "[email protected]"
}
}
}
]
}
]
}
}
]
}API key required for authentication.
Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.
GET /v2/campaigns Parameter
x >= 1GET /v2/campaigns Parameter
1 <= x <= 100Field to sort by
createdAt, updatedAt, name, status, startDate Sort direction
asc, desc Search query for filtering campaigns by name or description
Filter campaigns by status
draft, active, paused, completed, archived, inactive, cancelled, testing