Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Query Parameters

start_time
string

start_time

patient_phone_number
string

patient_phone_number

system_phone_number
string

system_phone_number

status
enum<string>

status

Available options:
open,
closed
practice_id
string

practice_id

opportunity_id
string

opportunity_id

search

caller_name
string

caller_name

non_practice_participant_type
enum<string>

non_practice_participant_type

Available options:
new_patient,
existing_patient
responsive_outreach_status
enum<string>

responsive_outreach_status

Available options:
working_aimee,
working_agent,
escalated,
not_applicable,
resolved_by_aimee,
resolved_by_agent,
closed
responsive_outreach_escalation_type
enum<string>

responsive_outreach_escalation_type

Available options:
aimee_initiated,
aimee_error,
user_initiated,
conversation_abandoned,
sms_failed,
insurance_not_accepted,
insurance_needs_verification,
prescription_refill_request,
patient_messaged_resolved_conversation,
user_stop_text_received,
aimee_hallucinated
is_webchat
string

is_webchat

is_voicechat
string

is_voicechat

custom_filter
enum<string>

custom_filter

Available options:
all_conversations,
patients_engaged,
action_required,
aimee_booked,
aimee_rescheduled,
aimee_cancelled,
aimee_confirmed,
staff_intervened,
staff_booked,
staff_rescheduled,
staff_cancelled,
staff_confirmed
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 conversations.

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