ASasksyllable
outbound.campaigns

List Outbound Communication Campaigns

Changed on
get/api/v1/outbound/campaigns

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/outbound/campaigns
  • Auth
    API key in header Syllable-API-Key

Query parameters

pageinteger nullable

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25
search_fieldsCampaignProperties[]

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

order_by'id' | 'campaign_name' | 'campaign_variables' | 'daily_start_time' | 'daily_end_time' | 'source' | 'mode' | 'caller_id' | 'updated_at' | 'label' | 'labels' | 'voicemail_detection'

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsCampaignProperties[] nullable

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z
end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "campaign_name": "Outbound Campaign 1",
      "description": "This is a test campaign",
      "mode": "voice",
      "sms_session_ttl": 720,
      "label": "test",
      "labels": [
        "test",
        "demo"
      ],
      "campaign_variables": {
        "key": "value",
        "key2": "value2"
      },
      "daily_start_time": "09:00:00",
      "daily_end_time": "17:00:00",
      "source": "+19032900844",
      "hourly_rate": 25,
      "max_daily_calls": 2500,
      "retry_count": 1,
      "retry_interval": "30m",
      "outreach_override_rules": {
        "days": {
          "sat": {
            "max_daily_calls": 0
          },
          "thu": {
            "max_daily_calls": 1300
          }
        },
        "dates": {
          "2026-11-26": {
            "active": false
          }
        }
      },
      "voicemail_detection": {
        "mode": "v1"
      },
      "allowed_line_types": [
        "mobile",
        "voip"
      ],
      "include_unknown_line_types": true,
      "target_filters": {
        "match": "all",
        "on_unknown": "include",
        "rules": [
          {
            "field": "line_type",
            "op": "in",
            "values": [
              "landline",
              "fixedVoip",
              "nonFixedVoip"
            ]
          },
          {
            "field": "caller_type",
            "op": "in",
            "values": [
              "BUSINESS"
            ]
          }
        ]
      },
      "id": 1,
      "created_at": "2026-11-02T00:00:00Z",
      "updated_at": "2026-11-02T00:00:00Z",
      "last_updated_by": "user@email.com",
      "webhooks": [
        {
          "url": "https://example.com/hooks/syllable",
          "request_method": "POST",
          "id": 1,
          "auth_value_keys": [
            "hmac_secret"
          ]
        }
      ]
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Changes

  • d861b61b3858Revision changes
    • info

      added the non-success response with the status

  • 4559c71cdfb7Revision changes
    • info

      added the optional property /// to the response with the status