Saltar al contenido principal
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>",
          "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": 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>"
  }
}

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

Opciones disponibles:
pending,
ready,
active,
inactive,
cooldown,
finished
​
integration
enum<string>

Type of integration for the Campaign

Opciones disponibles:
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:50

Number of items per page to return.

Rango requerido: x <= 100
​
cursor
string

Cursor to the next page to return.

Response

Campaigns response

​
total_count
integer

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

​
campaigns
object[]
​
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.