Skip to main content
GET
list a campaign's contacts

Authorizations

Authorization
string
header
required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Path Parameters

campaign_id
string<uuid>
required

the campaign's id.

Query Parameters

status
enum<string> | null

only contacts in this state. Where one contact of a campaign is in its dialling lifecycle.

PENDING has never been dialled; DIALING is claimed by the dialer (the call is being placed); IN_PROGRESS has a live run; RETRY_WAITING is due again at next_attempt_at; COMPLETED had a conversation; FAILED never connected within the retry budget; SKIPPED was left undialled because the campaign was cancelled.

Available options:
pending,
dialing,
in_progress,
retry_waiting,
completed,
failed,
skipped
page
integer
default:1

page number, from 1.

Required range: x >= 1
limit
integer
default:50

page size (1–200, default 50).

Required range: 1 <= x <= 200

Response

ok.

items
CampaignContact · object[]
required
count
integer
required
page
integer
required
totalPages
integer
required