Sign in
Campaigns

List Campaigns V2

get/v2/campaign

Query parameters

idstring
status'scheduled' | 'in-progress' | 'ended' | 'cancelled' | 'archived'
includeCountersboolean

When true, every campaign in the response includes contactCounters and callMetrics. These are aggregate queries over contacts and events — batched across the page, so the cost is three queries per request rather than three per campaign, but still opt-in rather than paid for on every read. Defaults to false.

pagenumber

This is the page number to return. Defaults to 1.

sortOrder'ASC' | 'DESC'

This is the sort order for pagination. Defaults to 'DESC'.

sortBy'createdAt' | 'duration' | 'cost'

This is the column to sort by. Defaults to 'createdAt'.

limitnumber

This is the maximum number of items to return. Defaults to 100.

createdAtGtstring date-time

This will return items where the createdAt is greater than the specified value.

createdAtLtstring date-time

This will return items where the createdAt is less than the specified value.

createdAtGestring date-time

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLestring date-time

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtstring date-time

This will return items where the updatedAt is greater than the specified value.

updatedAtLtstring date-time

This will return items where the updatedAt is less than the specified value.

updatedAtGestring date-time

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLestring date-time

This will return items where the updatedAt is less than or equal to the specified value.

Response

Changes