List Campaigns

Returns all Campaigns for your organization

GET /campaigns

cURL

cURL

curl --request GET \
  --url https://api.altur.io/api/v1.0/campaigns \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.altur.io/api/v1.0/campaigns"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.altur.io/api/v1.0/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.altur.io/api/v1.0/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.altur.io/api/v1.0/campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.altur.io/api/v1.0/campaigns")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.altur.io/api/v1.0/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "total_count": 123,
  "campaigns": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "status": "<string>",
      "created_at": "<string>",
      "started_at": "<string>",
      "ended_at": "<string>",
      "agent": {
        "id": "<string>",
        "name": "<string>"
      },
      "scheduling": {
        "mon": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "tue": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "wed": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "thu": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "fri": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "sat": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        },
        "sun": {
          "startTime": "<string>",
          "stopTime": "<string>",
          "active": true
        }
      },
      "timezone": "<string>",
      "retries": 123,
      "archived": true,
      "template": "<string>",
      "first_message": "<string>",
      "concurrency_limit": 123,
      "cycle_enabled": true,
      "cycle_max_iterations": 123,
      "cycle_cooldown_minutes": 123,
      "cycle_filter_statuses": [
        "<string>"
      ],
      "cycle_filter_tags": [
        "<string>"
      ],
      "cycle_current_iteration": 123,
      "cycle_last_iteration_at": "<string>"
    }
  ],
  "pagination": {
    "has_next": true,
    "has_previous": true,
    "next_cursor": "<string>",
    "previous_cursor": "<string>"
  }
}

{
  "field1": [
    "This field is required."
  ],
  "field2": [
    "Incorrect format."
  ],
  "non_field_errors": [
    "The date range is not valid."
  ]
}

{
  "error": 123,
  "message": "<string>"
}

Rate Limit: 12 requests per second

startDate/endDate are legacy names kept for backward compatibility and are actually equivalent to createdAfter/createdBefore (they filter on created_at, not on when the Campaign started or ended). Use startedAfter/startedBefore and endedAfter/endedBefore to filter by those dates instead. When both ends of a pair are provided, the after value must be earlier than before.

Authorizations

Authorization · string · header · required

Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.

Query Parameters

agentId · string<uuid4>

Filters the Campaigns by Agent ID of the agent assigned to the Campaign

status · enum<string>

Filters the Campaigns by the Status of the Campaign

Available options: pending, ready, active, inactive, cooldown, finished

integration · enum<string>

Type of integration for the Campaign

Available options: phone_call, whatsapp

startDate · string<ISO 8601>

Older name kept for backward compatibility, equivalent to createdAfter. Filters by created_at, not by start date.

endDate · string<ISO 8601>

Older name kept for backward compatibility, equivalent to createdBefore. Filters by created_at, not by end date.

createdAfter · string<ISO 8601>

Filter by created_at on or after this date.

createdBefore · string<ISO 8601>

Filter by created_at on or before this date.

startedAfter · string<ISO 8601>

Filter by started_at on or after this date. Excludes Campaigns that have not started.

startedBefore · string<ISO 8601>

Filter by started_at on or before this date. Excludes Campaigns that have not started.

endedAfter · string<ISO 8601>

Filter by ended_at on or after this date. Excludes Campaigns that have not ended.

endedBefore · string<ISO 8601>

Filter by ended_at on or before this date. Excludes Campaigns that have not ended.

archived · boolean · default: false

If true, archived Campaigns will be included in the results.

pageSize · integer · default: 50

Number of items per page to return.

Required range: x <= 100

cursor · string

Cursor to the next page to return.

Response

200

application/json

Campaigns response

total_count · integer

Total number of Campaigns for the given query. NOTE: The result is cache for 3 minutes.

campaigns · object[]

Show child attributes

pagination · object

Filters are applied to each request independently. Changing filters while paginating may result in gaps or overlaps in the result set. For consistent results, maintain the same filters throughout pagination.

Show child attributes