GEgetprosperapp
Campaigns

Get Campaign Targets

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

Request

  • Base URL
    https://voice.getprosperapp.com (the document declares no server; this is the origin it was published from)
  • URL
    https://voice.getprosperapp.com/api/v1/campaigns/{campaign_id}/targets
  • Auth
    none declared

Path parameters

campaign_idstring required

The ID of the campaign.

Query parameters

pageinteger

The page number to get.

limitinteger

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
to_datestring date-time nullable

The end date to get.

Example:2024-01-01
from_last_call_datestring date-time nullable

The date to get targets from the last call date.

Example:2024-01-01
to_last_call_datestring date-time nullable

The date to get targets to the last call date.

Example:2024-01-01
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.

external_idstring[] nullable

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.

Response

Successful Response

page_countinteger nullable
next_pageinteger nullable

Changes

  • 66e5e745a31dRevision changes
    • info

      added to the // response property anyOf list for the response status

  • dd21bc26a677Revision changes
    • warning

      added the new PATIENT_NOT_FOUND enum value to the /// response property for the response status