Skip to main content
GET
List Aimee conversations

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Query Parameters

practice_ids
string

Comma-separated list of practice IDs to filter conversations by specific practices. Example: '9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2'

organization_id
string

Organization ID to filter conversations within a specific organization. Example: '9AxAFr4n63uputNXKo89x1'

region_id
string

Region ID to filter conversations by a specific region. Example: '9AxAFr4n63uputNXKo89x1'

Search term to filter conversations by message content. Example: 'follow-up'

caller_name
string

Filter conversations by caller name. Example: 'John Doe'

start_time
string

Filter conversations by start time. Example: '2024-09-25T08:00:00Z'

non_practice_participant_type
enum<string>

Filter conversations by non-practice participant type. Example: 'new_patient'.

Available options:
new_patient,
existing_patient
responsive_outreach_status
enum<string>

Filter conversations by responsive outreach status. Example: 'working_aimee'.

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

Filter conversations by responsive outreach escalation. Example: 'aimee_initiated'.

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
custom_filter
enum<string>

Apply custom filters to conversations. Example: 'aimee_booked'.

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
sort_by
string
default:-start_time

Field by which to sort the conversations. Sorting can be done in ascending or descending order: For ascending order, provide the field name directly (e.g., 'start_time'). For descending order, prepend the field name with a hyphen (e.g., '-start_time'). Available fields for sorting include:

  • 'start_time': The time the conversation started.
  • 'end_time': The time the conversation ended.
  • 'most_recent_message_time': The time of the most recent message in the conversation.
  • 'most_recent_inbound_message_time': The time of the most recent inbound message.
  • 'patient_phone_number': The phone number of the patient.
  • 'system_phone_number': The system's phone number used in the conversation.
  • 'status': The status of the conversation (e.g., open, closed).
  • 'responsive_outreach_status': The status of the responsive outreach (e.g., working_aimee, escalated).
  • 'responsive_outreach_escalation_type': The escalation type in responsive outreach (e.g., aimee_error, user_initiated).
  • 'responsive_outreach_resolution_type': The resolution type for responsive outreach (e.g., booked, lost).
  • 'escalated_at': The time the conversation was escalated.
  • 'resolved_at': The time the conversation was resolved.
page_size
integer

Number of results to return per page. Defaults to the system-wide pagination settings if not provided. i.e: 50

page
integer

Page number to return. Defaults to the first page if not provided.

Response

A list of conversations.

caller_phone
string
required
Minimum string length: 1
date_time
string<date-time>
required
action_required
boolean
read-only
caller_name
string
read-only
current_type
enum<string>
read-only
Available options:
static,
responsive,
agent
escalations
object[]
read-only
id
string
read-only
Minimum string length: 1
is_action_required
string
read-only
non_practice_participant_type
string
read-only
opportunity
string | null
read-only
opportunity_status
string
read-only
origination_type
enum<string>
read-only
Available options:
static,
responsive,
agent
patients
object[]
read-only
resolutions
object[]
read-only
responsive_outreach_escalation_type
enum<string> | null
read-only
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
responsive_outreach_resolution_type
enum<string> | null
read-only
Available options:
booked,
lost,
cancelled,
rescheduled,
confirmed,
unspecified
responsive_outreach_status
enum<string>
read-only
Available options:
working_aimee,
working_agent,
escalated,
not_applicable,
resolved_by_aimee,
resolved_by_agent,
closed
status
enum<string>
read-only
Available options:
open,
closed
is_webchat
boolean
read-only
is_voicechat
boolean
read-only