Sign in

v6

latestOpenAPI 3.1.02026-08-03265555.4 KB
Campaigns

Get Campaign Targets

get/api/v1/campaigns/{campaign_id}/targets

Path parameters

campaign_idstring required

The ID of the campaign.

The ID of the campaign.

Query parameters

pageinteger

The page number to get.

The page number to get.

limitinteger

The number of targets per page.

The number of targets per page.

status'Pending' | 'Scheduled' | 'In Progress' | 'Post-processing' | 'Finished' | 'Failed' | 'Waiting' | 'SMS Scheduled'

The status of the targets to get.

from_datestring date-time nullable

The start date to get.

Example:2024-01-01

The start date to get.

to_datestring date-time nullable

The end date to get.

Example:2024-01-01

The end date to get.

from_last_call_datestring date-time nullable

The date to get targets from the last call date.

Example:2024-01-01

The date to get targets from the last call date.

to_last_call_datestring date-time nullable

The date to get targets to the last call date.

Example:2024-01-01

The date to get targets to the last call date.

patient_external_idstring[] nullable

Filter to targets whose patient.external_id is in this list. Repeat the param to batch (e.g. ?patient_external_id=A&patient_external_id=B); max 100 per request.

Filter to targets whose patient.external_id is in this list. Repeat the param to batch (e.g. ?patient_external_id=A&patient_external_id=B); max 100 per request.

external_idstring[] nullable

Filter to targets whose external_id is in this list; max 100 per request.

Filter to targets whose external_id is in this list; max 100 per request.

phone_numberstring[] nullable

Filter to targets that have any of these phone numbers; max 100 per request.

Filter to targets that have any of these phone numbers; max 100 per request.

Response

Successful Response

page_countinteger nullable
next_pageinteger nullable