Skip to main content
GET
List opportunities

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Query Parameters

id
string

id

originating_call_id
string

originating_call_id

resolving_call_id
string

resolving_call_id

trigger_type
enum<string>

trigger_type

Available options:
missed_call,
missed_call_existing_patient,
missed_call_cancellation_reschedule,
missed_call_current_appointment,
missed_call_non_business,
missed_call_business,
high_value_missed_call,
connected_call,
connected_call_existing_patient,
connected_call_new_patient,
connected_call_high_value,
lost_opportunity,
lost_opportunity_new_patient,
lost_opportunity_existing_patient,
lost_opportunity_high_value,
aimee_escalation,
aimee_booked,
aimee_reschedule,
aimee_cancellation,
aimee_inbound_message,
extracted_opportunity,
care_task_handed_off,
voip_integration_disconnect,
ehr_integration_disconnect,
fax_inbound_received,
fax_outbound_failed
is_open
string

is_open

status
enum<string>

status

Available options:
success,
failure,
omitted
opportunity_origin_type
enum<string>

opportunity_origin_type

Available options:
call_connected,
call_missed,
message_received,
voicemail_received
originating_call__call_start_time
string

originating_call__call_start_time

originated_at
string

originated_at

is_followed_up
string

is_followed_up

has_any_follow_up
string

has_any_follow_up

practice_id
string
required

practice_id

sort
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Response

Successful response for list opportunities.

count
integer
required
results
object[]
required
next
string<uri> | null
previous
string<uri> | null