curl --request GET \
--url https://app2.freyavoice.ai/api/v2/campaign \
--header 'Authorization: Bearer <token>'{
"success": true,
"data": {
"message": "<string>",
"result": {
"campaigns": [
{
"id": "<string>",
"name": "<string>",
"workspaceId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"assistantId": "<string>",
"phoneNumberId": "<string>",
"description": "<string>",
"status": "draft",
"startDate": "2023-12-25",
"startTime": "<string>",
"timezone": "UTC",
"endTime": "<string>",
"activeDays": [
0,
1,
2,
3,
4,
5,
6
],
"phoneNumber": "<string>",
"callRetries": 0,
"retryDelaySeconds": 300,
"retryDelayMode": "fixed",
"retryConditions": [
"No Answer",
"Busy",
"Timeout",
"Unreachable",
"Network Error",
"Resource Unavailable",
"Service Unavailable",
"voicemail"
],
"endDate": "2023-12-25",
"schedulingMode": "even",
"callIntervalSeconds": 30,
"maxConcurrency": 5,
"webhookUrl": "<string>",
"customers": [],
"callIds": [],
"roomNames": [],
"events": [],
"version": "v1",
"customerCount": 123,
"callCount": 123
}
],
"pagination": {
"total": 123,
"limit": 123,
"offset": 123
},
"statusCounts": {
"all": 123,
"active": 123,
"scheduled": 123,
"completed": 123,
"partiallyCompleted": 123,
"draft": 123
}
}
}
}Returns campaigns for a workspace with filters, sorting, pagination, and export support.
curl --request GET \
--url https://app2.freyavoice.ai/api/v2/campaign \
--header 'Authorization: Bearer <token>'{
"success": true,
"data": {
"message": "<string>",
"result": {
"campaigns": [
{
"id": "<string>",
"name": "<string>",
"workspaceId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"assistantId": "<string>",
"phoneNumberId": "<string>",
"description": "<string>",
"status": "draft",
"startDate": "2023-12-25",
"startTime": "<string>",
"timezone": "UTC",
"endTime": "<string>",
"activeDays": [
0,
1,
2,
3,
4,
5,
6
],
"phoneNumber": "<string>",
"callRetries": 0,
"retryDelaySeconds": 300,
"retryDelayMode": "fixed",
"retryConditions": [
"No Answer",
"Busy",
"Timeout",
"Unreachable",
"Network Error",
"Resource Unavailable",
"Service Unavailable",
"voicemail"
],
"endDate": "2023-12-25",
"schedulingMode": "even",
"callIntervalSeconds": 30,
"maxConcurrency": 5,
"webhookUrl": "<string>",
"customers": [],
"callIds": [],
"roomNames": [],
"events": [],
"version": "v1",
"customerCount": 123,
"callCount": 123
}
],
"pagination": {
"total": 123,
"limit": 123,
"offset": 123
},
"statusCounts": {
"all": 123,
"active": 123,
"scheduled": 123,
"completed": 123,
"partiallyCompleted": 123,
"draft": 123
}
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Workspace identifier
1Page size
Offset for pagination
Base64-encoded filter state
Global search term
Sort field name
Sort direction
asc, desc Set to 'true' to return a file export
Export file format
csv, xlsx, markdown JSON array of column definitions {id,label}