Sign in

v1

latestSwagger 2.02026-08-06114161439.7 KB
campaign

List of campaigns belonging to the user group and all children

Retrieves campaigns accessible within the user's organizational hierarchy. Returns campaign metadata including names, status, tracking numbers, and routing configurations. Supports pagination and filtering.

get/campaign/list

Query parameters

limitinteger

Maximum number of records to return per page. Integer, default 100, max 2000, min 1.

offsetinteger

Number of records to skip from the start of the result set. Integer, default 0, max 100000, min 0. Use with limit for pagination.

filterstring[]

URL-encoded comma-separated list of filter conditions in the form '<field> <op> <value>' where op is one of =, !=, <=, >=, >, <, like (spaces required around 'like'). Example: 'call_started > 2024-01-01'. Max 10 conditions. Filterable fields vary by endpoint.

Response

Campaign records with metadata and configuration summaries

campaign_idinteger

Unique identifier for the campaign this call was attributed to. Integer.

campaign_namestring required

Human-readable campaign name. String.

campaign_ext_idstring

Customer-provided external identifier for the campaign. Integer.

campaign_status'active' | 'inactive' | 'suspended'

The current status of the campaign. Type: enum (string); Allowed values: active, inactive, suspended.

campaign_createdstring date-time

The date and time of when the campaign record was created. Type: string (date-time).

campaign_modifiedstring date-time

A date and time stamp of the last time anything was modified on campaign. Type: string (date-time).

campaign_start_datestring date-time required

The date and time that the campaign is activated. Type: string (date-time).

campaign_end_datestring date-time

The date and time at which the campaign will end. Type: string (date-time).

campaign_owner_user_idinteger required

The unique ID of the user that is the owner of the campaign. Type: integer (int32).

group_idinteger required

Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.

owner_fnamestring

The first name of the campaign owner. Type: string.

owner_lnamestring

The last name of the campaign owner. Type: string.