Skip to main content
GET
/
api
/
v1
/
targets
/
{target_id}
Retrieve Target
curl --request GET \
  --url https://api.example.com/api/v1/targets/{target_id}
{
  "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": {}
}

Path Parameters

​
target_id
string
required

The ID of the target to get the required variables from.

Response

Successful Response

​
id
string
required
​
target_url
string
required
​
organization_id
string
required
​
campaign_id
string
required
​
created_at
string<date-time>
required
​
execution_minutes
integer | null
required
​
input_data
Input Data · object
required
​
output_data
Output Data · object
required
​
status
enum<string>
required
Available options:
Pending,
Scheduled,
In Progress,
Finished,
To review,
Failed,
Waiting,
SMS Scheduled
​
resolution
required
Available options:
retrieved,
not_retrieved
​
category
required
Available options:
NO_RESPONSE,
TRANSFER,
TRANSFER_FAILED,
VOICEMAIL,
SERVICE_NOT_AVAILABLE,
HUMAN_ONLY,
AFTER_HOURS,
CLOSED_FOR_HOLIDAYS,
IVR_LOOP,
INPUT_DATA_ISSUE,
WRONG_PHONE_NUMBER,
NOT_FOUND,
UNPROCESSABLE_BY_PHONE,
DISCONNECTED,
NOT_ALL_DATA_POINTS_RETRIEVED,
MEMBER_CONSENT_REQUIRED,
SLA_EXPIRED,
PAYOR_NOT_SUPPORTED,
NO_OPERATING_HOURS
​
subcategory
required
Available options:
PROVIDER,
MEMBER,
FACILITY,
REQUEST,
OTHER
​
call_log_ids
integer[] | null
required
​
last_call_date
string<date-time> | null
required
​
phone_number
string | null
required
​
fax_links
string[] | null
required
​
payor_api_data
Payor Api Data · object
required
​
updated_at
string<date-time> | null
​
retries
integer | null
​
scheduled_time
string<date-time> | null
​
categorization
Categorization · object
​
outcome
string | null
​
statistics
Statistics · object