Skip to main content
GET
/
campaign
List campaigns
curl --request GET \
  --url https://app.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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "phoneNumberId": "<string>",
          "description": "<string>",
          "status": "draft",
          "startDate": "2023-12-25",
          "startTime": "<string>",
          "timezone": "UTC",
          "endTime": "<string>",
          "activeDays": [
            0,
            1,
            2,
            3,
            4,
            5,
            6
          ],
          "daySchedules": {},
          "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
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
workspaceId
string<uuid>
required

Workspace identifier

​
limit
string
default:25

Page size

​
offset
string
default:0

Offset for pagination

​
filters
string

Base64-encoded filter state

​
search
string

Global search term

​
sortBy
string

Sort field name

​
sortOrder
enum<string>

Sort direction

Available options:
asc,
desc
​
export
string

Set to 'true' to return a file export

​
exportFormat
enum<string>

Export file format

Available options:
csv,
xlsx,
markdown
​
exportColumns
string

JSON array of column definitions {id,label}

Response

Campaigns with pagination and status counts

​
success
enum<boolean>
required
Available options:
true
​
data
object
required