Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaign_id}
/
patient
/
targets
Get Patient Campaign Targets
curl --request GET \
  --url https://api.example.com/api/v1/campaigns/{campaign_id}/patient/targets
{
  "targets": [
    {
      "id": "<string>",
      "target_url": "<string>",
      "organization_id": "<string>",
      "campaign_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "execution_minutes": 123,
      "input_data": {},
      "output_data": {},
      "status": "Pending",
      "resolution": "retrieved",
      "category": "NO_RESPONSE",
      "subcategory": "PROVIDER",
      "call_log_ids": [
        123
      ],
      "last_call_date": "2023-11-07T05:31:56Z",
      "phone_number": "<string>",
      "fax_links": [
        "<string>"
      ],
      "payor_api_data": {},
      "updated_at": "2023-11-07T05:31:56Z",
      "retries": 123,
      "scheduled_time": "2023-11-07T05:31:56Z",
      "categorization": {},
      "outcome": "<string>",
      "statistics": {}
    }
  ],
  "page_count": 123,
  "next_page": 123
}

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,
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