GET
Get Campaign
Returns the full detail of a single campaign, including its agent configuration, schedule constraints, and retry policy.
The List Campaigns endpoint returns summary metadata only (CampaignMetadata). Use this endpoint when you need the full app_config, allowed_schedule, or timestamp details.

Authorizations

X-API-Key
string
header
required

Path Parameters

org_id
string
required
workspace_id
string
required
campaign_id
string
required

Response

Successful Response

Full campaign details including agent configuration, schedule, and retry policy.

name
string
required

Name of the resource

Example:

"Q1 Payment Reminders"

campaign_id
string
required

Unique identifier for the campaign

Example:

"camp-a1b2c3d4"

status
enum<string>
required

Current status

Available options:
ended,
active,
paused,
scheduled,
cancelled
Example:

"scheduled"

app_id
string
required

ID of the agent

Example:

"payment-reminder-agent"

created_by
string
required

User who created this resource

Example:

"user@company.com"

created_at
string<date-time>
required

Timestamp when the resource was created (ISO 8601)

Example:

"2026-03-28T10:00:00Z"

updated_at
string<date-time>
required

Timestamp when the resource was last updated (ISO 8601)

Example:

"2026-04-01T09:00:00Z"

app_config
Agent Config · object
required

Agent configuration for the campaign

start_timestamp
string<date-time>
required

Campaign start time (ISO 8601)

Example:

"2026-04-01T09:00:00Z"

end_timestamp
string<date-time>
required

Campaign end time (ISO 8601)

Example:

"2026-04-15T18:00:00Z"

allowed_schedule
AllowedScheduleConfig · object
required

Schedule constraints for when the campaign can run

description
string | null

Optional description

Example:

"Outbound reminder calls for Q1 overdue accounts"

app_type
enum<string>
default:agent

Type of agent

Available options:
agent
Example:

"agent"

app_version
integer | null

Version of the agent to use

Example:

1

updated_by
string | null

User who last updated this resource

Example:

"user@example.com"