GET
/
campaigns
cURL
curl --request GET \
  --url https://api.altur.io/api/v1.0/campaigns \
  --header 'Authorization: <api-key>'
{
  "total_count": 123,
  "campaigns": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "status": "<string>",
      "created_at": "<string>",
      "agent": {
        "id": "<string>",
        "name": "<string>"
      },
      "scheduling": {
        "mon": {
          "startTime": "<string>",
          "endTime": "<string>",
          "active": true
        },
        "tue": {
          "startTime": "<string>",
          "endTime": "<string>",
          "active": true
        },
        "wed": {
          "startTime": "<string>",
          "endTime": "<string>",
          "active": true
        },
        "thu": {
          "startTime": "<string>",
          "endTime": "<string>",
          "active": true
        },
        "fri": {
          "startTime": "<string>",
          "endTime": "<string>",
          "active": true
        },
        "sat": {
          "startTime": "<string>",
          "endTime": "<string>",
          "active": true
        },
        "sun": {
          "startTime": "<string>",
          "endTime": "<string>",
          "active": true
        }
      },
      "timezone": "<string>",
      "retries": 123,
      "concurrency": 123,
      "archived": true,
      "template": "<string>",
      "first_message": "<string>",
      "cycle_enabled": true,
      "cycle_max_iterations": 123,
      "cycle_cooldown": 123,
      "cycle_status_filters": [
        "<string>"
      ],
      "cycle_tag_filters": [
        "<string>"
      ],
      "cycle_current_iteration": 123,
      "last_iteration_at": "<string>"
    }
  ],
  "pagination": {
    "has_more": true,
    "has_previous": true,
    "next_cursor": "<string>",
    "previous_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

agent_id
string

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

status
enum<string>

Filters the Campaigns by 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>

Bottom date of the range to filter the Campaigns in ISO 8601 format

endDate
string<ISO 8601>

Top date of the range to filter the Campaigns in ISO 8601 format

archived
boolean
default:false

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

pageSize
integer
default:25

Number of items per page to return.

Required range: x <= 100
cursor
string

Cursor to the next page to return.

direction
enum<string>
default:next

Direction of the cursor to return the results in.

Available options:
next,
previous

Response

Campaigns response

total_count
integer

Total number of Campaigns for the given query

campaigns
object[]
pagination
object