Sign in
Campaigns

Get Campaign V2

get/v2/campaign/{id}

Path parameters

idstring uuid required

The unique identifier for the resource.

Query parameters

includeCountersboolean

When true, the response includes contactCounters and callMetrics. These are aggregate queries over the campaign's contacts and events, so they are opt-in rather than paid for on every read. Defaults to false.

Response

status'scheduled' | 'in-progress' | 'ended' | 'cancelled' | 'archived' required

This is the status of the campaign.

endedReason'campaign.scheduled.ended-by-user' | 'campaign.in-progress.ended-by-user' | 'campaign.ended.success'

This is the explanation for how the campaign ended.

namestring required

This is the name of the campaign. This is just for your own reference.

assistantIdstring

This is the assistant ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.

squadIdstring

This is the squad ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.

phoneNumberIdstring

This is the phone number ID that will be used for the campaign calls. Required if dialPlan is not provided. Note: phoneNumberId and dialPlan are mutually exclusive.

maxConcurrencynumber

This is the maximum number of concurrent calls that will be made for the campaign. Defaults to 10.

serverMessagesstring[]

These are the messages that will be sent to your Server URL.

idstring required

This is the unique identifier for the campaign.

orgIdstring required

This is the unique identifier for the org that this campaign belongs to.

createdAtstring date-time required

This is the ISO 8601 date-time string of when the campaign was created.

updatedAtstring date-time required

This is the ISO 8601 date-time string of when the campaign was last updated.

Changes