API DocumentationCampaigns

Get Campaigns

Get all call campaigns.

Args: sort_by: Field to sort by. Options: name, status, created_at sort_direction: Direction to sort. Options: asc (ascending), desc (descending)

GET
/v1/campaigns
AuthorizationBearer <token>

In: header

Query Parameters

sort_by?Sort By
Default"name"
sort_direction?Sort Direction
Default"asc"
page?Page
Default1
Range1 <= value
page_size?Page Size

Response Body

curl -X GET "https://api.voxxi.ai/v1/campaigns/?sort_by=name&sort_direction=asc&page=1&page_size=1"
{
  "items": [
    {
      "id": 0,
      "name": "string",
      "status": "draft",
      "created_at": "2019-08-24T14:15:22Z",
      "prospect_count": 0,
      "total_calls_count": 0,
      "completed_calls_count": 0,
      "agent_name": "string"
    }
  ],
  "count": 0
}
{
  "detail": "string"
}
{
  "detail": "string"
}
{
  "detail": "string"
}
{
  "detail": [
    {
      "type": "string",
      "loc": [
        "string"
      ],
      "msg": "string",
      "ctx": {}
    }
  ]
}
{
  "detail": "string"
}