GET
/
api
/
v1
/
outbound
/
campaigns

Authorizations

Syllable-API-Key
string
header
required

Query Parameters

page
integer | null
default:
0
Required range: x > 0
limit
integer
default:
25
Required range: x > 0
search_fields
enum<string>[]
Available options:
id,
campaign_name,
campaign_variables,
status,
daily_start_time,
daily_end_time,
timezone,
mode
search_field_values
string[]
order_by
enum<string> | null
Available options:
id,
campaign_name,
campaign_variables,
status,
daily_start_time,
daily_end_time,
timezone,
mode
order_by_direction
enum<string> | null
Available options:
asc,
desc
fields
enum<string>[] | null
Available options:
id,
campaign_name,
campaign_variables,
status,
daily_start_time,
daily_end_time,
timezone,
mode
start_datetime
string | null
end_datetime
string | null

Response

200
application/json
campaign_name
string
required

Human readable name of campaign

campaign_variables
object
required

Variables for campaign

daily_start_time
string
required

Start time of campaign

daily_end_time
string
required

End time of campaign

timezone
string
required

Timezone of campaign

id
integer
required

Unique ID for campaign

last_updated_by
string
required

User who last updated campaign

status
enum<string>

Status of campaign

Available options:
PENDING,
ACTIVE,
PAUSED,
CANCELED
mode
enum<string>

Batch or Interactive

Available options:
BATCH,
INTERACTIVE
created_at
string

Timestamp of campaign creation

updated_at
string

Timestamp of campaign update