GET
List reachability checks

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.

Query Parameters

status
enum<string>

Only checks with this status. running (dialling), waiting_window (outside your calling hours, numbers wait), queued (paused on our side, for example reachability was disabled after creation), then completed or canceled.

Available options:
queued,
running,
waiting_window,
completed,
canceled
mode
enum<string>

Only answer checks or only ring checks. answer (default): wait for a pick-up, hold the line hold_sec seconds and hang up. ring: hang up as soon as the phone has rung ring_sec seconds; nobody needs to pick up (the customer sees a missed call).

Available options:
answer,
ring
include_campaign
enum<string>

true also lists the ones your campaigns created (one per contact step; by default they are left out: see each campaign's contacts).

Available options:
true,
false
created_from
string<date-time>

Only items created at or after this instant (ISO 8601 with Z or an offset).

created_until
string<date-time>

Only items created at or before this instant (ISO 8601 with Z or an offset).

limit
integer
default:50

Page size.

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

next_cursor of the previous page.

Minimum string length: 1

Response

A page of checks.

data
object[]
required
next_cursor
string | null
required