Skip to main content
GET
Get Patient Campaign Targets

Path Parameters

campaign_id
string
required

The ID of the campaign.

Query Parameters

page
integer
default:0

The page number to get.

Required range: x >= 0
limit
integer
default:10

The number of targets per page.

Required range: 1 <= x <= 100
status
enum<string> | null

The status of the targets to get.

Available options:
Pending,
Scheduled,
In Progress,
Post-processing,
Finished,
To review,
Failed,
Waiting,
SMS Scheduled
from_date
string<date-time> | null

The start date to get.

Example:

"2024-01-01"

to_date
string<date-time> | null

The end date to get.

Example:

"2024-01-01"

from_last_call_date
string<date-time> | null

The date to get targets from the last call date.

Example:

"2024-01-01"

to_last_call_date
string<date-time> | null

The date to get targets to the last call date.

Example:

"2024-01-01"

Response

Successful Response

Paginated response for patient campaign targets using the optimized vw_campaign_targets_export_patient view (no fax_links or payor_api_data).

targets
CampaignTargetPatientResponse · object[]
required
page_count
integer | null
next_page
integer | null