GET
List the records of a campaign

Authorizations

Authorization
string
header
required

Authorization: Bearer vg_live_<32 hex characters>. Keys are issued by Mergen admins and shown once. Missing or invalid key: 401 unauthorized. Suspended account: 403 tenant_suspended.

Path Parameters

campaignId
string
required

Campaign id (cmp_ + 32 hex characters).

Query Parameters

status
enum<string>

Only records with this status. pending (waiting for its next attempt), calling (an attempt is on the line), completed (finished with a success, another final outcome or a wrong number), exhausted (attempts or the schedule used up), closed (do not call, paid, or canceled) and skipped (never called: invalid phone, duplicate or missing variables).

Available options:
pending,
calling,
completed,
exhausted,
closed,
skipped
result
enum<string>

Only records with this result. How a record ended: success (an outcome of goal.outcomes), wrong_number, final_outcome (another outcome that ends the record; result_detail names it), exhausted (no attempt left), end_date (the schedule ended first), do_not_call, paid (a customer event), canceled, invalid_phone, duplicate and missing_variables (result_detail lists them).

Available options:
success,
wrong_number,
final_outcome,
exhausted,
end_date,
do_not_call,
paid,
canceled,
invalid_phone,
duplicate,
missing_variables

Part of a phone number or an external_id.

Required string length: 1 - 100
limit
integer
default:50

Page size.

Required range: 1 <= x <= 500
cursor
string

next_cursor of the previous page.

Minimum string length: 1

Response

A page of records.

data
object[]
required
next_cursor
string | null
required