> ## Documentation Index > Fetch the complete documentation index at: https://docs.peerlogic.com/llms.txt > Use this file to discover all available pages before exploring further. # List calls ## OpenAPI ````yaml /openapi/peerlogic-api.json get /api/calls/ openapi: 3.1.0 info: title: Peerlogic API version: 1.0.0 description: >- Customer-facing API reference for accessing Peerlogic calls, insights, conversations, tasks, opportunities, subscriptions, and events. servers: - url: https://api.prod.peerlogic.com description: Production security: [] tags: - name: Authentication description: Obtain an access token for authenticated API requests. - name: Call insights description: Call records and aggregate performance insights. - name: Transcripts description: Transcripts, summaries, sentiment, pauses, and call-purpose details. - name: Aimee description: Aimee activity, configuration, and performance insights. - name: Conversations description: Conversation records, messages, and conversation actions. - name: Tasks description: Customer tasks and task workflow actions. - name: Opportunities description: Opportunities and follow-up reporting. - name: Subscriptions and events description: >- Create and manage event subscriptions, then inspect event records and analytics. For the complete webhook delivery flow, see the Webhooks and subscriptions guide. - name: Organizations and practices description: >- Discover the organizations and practices available to the authenticated account. - name: Contacts and patients description: Find contacts and patients for caller recognition and related workflows. - name: Appointments description: Retrieve appointment history and upcoming appointments for a patient. - name: Messaging description: Send practice messages, including missed-call recovery outreach. - name: Call recordings description: Retrieve recording metadata and secure audio URLs for calls. paths: /api/calls/: parameters: [] get: tags: - Call insights summary: List calls operationId: calls_list parameters: - name: id in: query description: id required: false schema: type: string - name: practice__id in: query description: practice__id required: false schema: type: string - name: call_direction__in in: query description: call_direction__in required: false schema: type: string - name: call_direction in: query description: call_direction required: false schema: type: string enum: - inbound - outbound - internal - name: call_connection in: query description: call_connection required: false schema: type: string enum: - missed - connected - name: duration_seconds__gte in: query description: duration_seconds__gte required: false schema: type: string - name: duration_seconds__lte in: query description: duration_seconds__lte required: false schema: type: string - name: went_to_voicemail in: query description: went_to_voicemail required: false schema: type: string - name: checked_voicemail in: query description: checked_voicemail required: false schema: type: string - name: call_sentiments__overall_sentiment_score__in in: query description: call_sentiments__overall_sentiment_score__in required: false schema: type: string - name: call_sentiments__overall_sentiment_score in: query description: call_sentiments__overall_sentiment_score required: false schema: type: string enum: - positive - neutral - negative - not_applicable - name: mentioned_companies__keyword in: query description: mentioned_companies__keyword required: false schema: type: string enum: - 3m_oral_care - amazon - benco_dental - biteline - biolase - carestream - collaborativecare - colgate_palmolive_company - crest - darby_dental_supplies - dental_intel - google - henry_schein - kerr - metrex - microsoft - midwest_dental_equipment_supplies - mydent - nexhealth - noble_dental_supplies - opencare - overjet - peerlogic - patient_prism - patterson_dental - pearson_dental_supply - philips - relu - safeco - septodont - smile_direct - sultan_healthcare - vyne - weave - zocdoc - name: mentioned_insurances__keyword in: query description: mentioned_insurances__keyword required: false schema: type: string enum: - aarp_dental_insurance - aetna - aetna_better_health - aetna_vital_savings - aflac - ahcccs_dental - alabama_medicaid - alaska_medicaid - alohacare - allstate - altus_dental - always_care - ambetter - amerigroup - amerihealth_caritas - ameritas - anthem - anthem_healthkeepers_plus - arkansas_medicaid - assurant - avesis - beam_dental - benecare_dental - best_life_dental - blue_cross_blue_shield - blue_cross_complete - blue_cross_idaho - bmc_healthnet_plan - bravo_health - capital_blue_cross - careington - caresource - cigna - colorado_medicaid - common_ground_healthcare - coventry - cypress_dental - dearborn_national - delaware_medicaid - deltacare_usa - delta_dental - delta_dental_fedvip - denali - dentalplans_dot_com - dental_health_and_wellness - dentaquest - denti_cal - dominion_national - elderplan - emblem_health - emi_health - envolve_dental - equitable - excellus_bcbs - fallon_health - fidelis_care - first_health - geha - guardian - guardian_dental_exchange - harvard_pilgrim - hawaii_dental_service - hawaii_medicaid - healthfirst - healthpartners_dental - healthy_ny - health_choice_access - health_net_dental - health_new_england - health_plan_of_nevada - humana - husky_health - idaho_medicaid - illinois_medicaid - independence_bcbs - indiana_medicaid - iowa_medicaid - kancare - kentucky_medicaid - liberty_dental_plan - lincoln_financial - livewell_dental_access - louisiana_dental_bayou_health - mainecare - maryland_healthy_smiles - masshealth - mcna_dental - medicaid - medicare - medstar_family_choice - mercy_care - meritain - metlife - metlife_fedvip - metroplushealth - michigan_healthy_kids_dental - minnesota_medicaid - mississippi_medicaid - missouri_medicaid - moda_health - molina_healthcare - montana_medicaid - mutual_of_omaha - nationwide - nc_healthy_opportunities - nebraska_medicaid - nevada_check_up - nj_familycare - nm_medicaid - north_dakota_medicaid - ohio_medicaid - oklahoma_soonercare - oregon_dental_services_companies - oregon_health_plan - oscar_health - pacificsource - peach_state_health - pennsylvania_chip - physicians_mutual - premera_blue_cross - premier_access - principal - principal_dental - regence_blueshield - reliance_standard - renaissance_dental - rhode_island_medicaid - safeguard - secure_care_dental - security_health_plan - seiu_1199_nbf - select_health - sierra_health_and_life - solstice_dental - southwest_service - south_carolina_medicaid - south_dakota_medicaid - spirit_dental - standard_insurance - state_insurance - sunshine_health - sun_life_dental - sun_life_financial - tenncare - texas_medicaid_dental - the_loomis_company - transamerica - tricare - trustmark - tufts_health_plan - uhc_community_plan - uhc_dual_completion - united_concordia - united_healthcare - unum_dental - utah_medicaid - vermont_medicaid - virginia_smiles_for_children - vsp_global - washington_apple_health - wellcare - wellpoint - west_virginia_chip - wisconsin_badgercare - wyoming_medicaid - ameriben - benefit_admin_solution - dmba - ebms - group_administrators - health_ez - health_west_administrators - ninety_degree_benefits - sisco - tall_tree_admin - total_dental_admin - umr - web_tpa - access_dental - advanced_benefit_solution - alaska_teamster - altius - apwu - colonial_life - dental_select - dentamax - direct_care - educators_mutual_emi - employee_painters_trust - freedom_fountain_life - guarantee_trust_life - ironworkers - kansas_city_life - laborers_trust_utah - line_co - mailhandlers - motiv_health - navajo_nation_employee_benefits - nwsm - painter_welfare_trust - pipe_trades_ironworkers_utah - teamsters_security_fund_utah - wcf_insurance - welfare_trust_fund - cdcp - nihb - ifhp - odsp - healthy_smiles_ontario - ontario_works - ontario_seniors_dental_care - cinot - ramq - aish - alberta_adult_health_benefit - alberta_child_health_benefit - bc_healthy_kids - bc_income_assistance_dental - manulife - canada_life - desjardins_insurance - green_shield_canada - alberta_blue_cross - pacific_blue_cross - medavie_blue_cross - manitoba_blue_cross - saskatchewan_blue_cross - beneva - ia_financial_group - empire_life - equitable_life_canada - co_operators - chambers_plan - grouphealth - claimsecure - gms - name: mentioned_procedures__keyword in: query description: mentioned_procedures__keyword required: false schema: type: string enum: - abutment - bonding - braces - bridge - cleaning - cone_beam - crown - dentures - exam - extraction - filling - filling_amalgam - filling_composite - implant - polishing - repair - root_canal - screw - sedation - tmj - x_ray - veneer - whitening - biopsy_organ - bloat - catheterization_urinary - dental - disease_disc - dystocia - extraction - surgery_ostectomy_head_femoral - injections_allergy - minimally_invasive_procedure - mri_post - neuter - removal_mass - repair_acl - repair_jawline - replacement_hip_total - retrieval_body_foreign - scoping - sedation_ultrasound - spay - surgery_back - surgery_spinal - surgery_tissue_soft - tap_joint - testing_allergy - treatment_chemotherapy - treatment_gastric_dilation_volvulus - treatment_laceration - treatment_pyometra - treatment_stem_cell - vaccine_oncological - name: mentioned_products__keyword in: query description: mentioned_products__keyword required: false schema: type: string enum: - aligner - at_home_whitening - axium - carestack - crest_whitestrips - curve_hero - denticon - dentrix - dentrix_ascend - eaglesoft - floss - invisalign - modento - night_guard - open_dental - patientpop - retainer - sonicare - solutionreach - sure_smile_aligner - toothbrush - toothbrush_electric - toothpaste - zoom_whitening - waterpik - name: mentioned_symptoms__keyword in: query description: mentioned_symptoms__keyword required: false schema: type: string enum: - breath_bad - bleeding - blood - bruising - dry_socket - dysphagia - excessive_drooling - headache - jaw_soreness - lesion - mouth_dry - numbness - pain - snoring - swelling - throat_soreness - tooth_chipped - tooth_cracked - tooth_loss - tooth_sensitivity - toothache - overbite - underbite - name: sip_caller_extension in: query description: sip_caller_extension required: false schema: type: string - name: sip_caller_number__startswith in: query description: sip_caller_number__startswith required: false schema: type: string - name: sip_callee_number__startswith in: query description: sip_callee_number__startswith required: false schema: type: string - name: extension_any in: query description: extension_any required: false schema: type: string - name: phone_number_any in: query description: phone_number_any required: false schema: type: string - name: name_any in: query description: name_any required: false schema: type: string - name: has_notes in: query description: has_notes required: false schema: type: string - name: notes_search in: query description: notes_search required: false schema: type: string - name: call_start_time_after in: query description: Return calls on or after this date (YYYY-MM-DD). required: false schema: type: string format: date - name: call_start_time_before in: query description: Return calls before this date (YYYY-MM-DD). required: false schema: type: string format: date - name: marketing_campaign_id in: query description: marketing_campaign_id required: false schema: type: string - name: has_patients__appointments in: query description: has_patients__appointments required: false schema: type: string - name: call_purposes__call_purpose_type in: query description: call_purposes__call_purpose_type required: false schema: type: string enum: - new_appointment - reschedule - confirm_appointment - cancel_appointment - inquiry_administrative - inquiry_patient_education - inquiry_er - pricing - request_referral - request_medical_records - request_prescription - billing - transfer_care - administrative - employment - personal - others - insurance_authorization - insurance_verification - insurance_claim - name: call_purposes__outcome_results__call_outcome_type in: query description: call_purposes__outcome_results__call_outcome_type required: false schema: type: string enum: - success - failure - not_applicable - name: >- call_purposes__outcome_results__outcome_reason_results__call_outcome_reason_type in: query description: >- call_purposes__outcome_results__outcome_reason_results__call_outcome_reason_type required: false schema: type: string enum: - not_enough_information_possesed_by_patient_or_agent - patient_lacks_information_to_complete_request - practice_lacks_information_to_complete_request - procedure_not_offered - treatment_not_offered - patient_ineligible_for_treatment - caller_indifference - insurance - insurance_not_taken - pricing - financial - lost - too_expensive - scheduling - day_or_time_not_available - call_interrupted - call_not_connected - others - not_applicable - incorrect_dental_code - incomplete_information_on_claim - insurance_coverage_limit_annual - insurance_coverage_limit_lifetime - insurance_coverage_time_limit - insurance_incorrect_beneficiary_information - insurance_coverage_expired - insurance_coordination_of_benefits - insurance_preauthorization_not_obtained - insurance_procedure_not_covered - name: engaged_in_calls__non_agent_engagement_persona_type in: query description: engaged_in_calls__non_agent_engagement_persona_type required: false schema: type: string enum: - new_patient - existing_patient - contractor_vendor - insurance_provider - not_applicable - not_applicable_internal - others - name: patients__appointments__status in: query description: patients__appointments__status required: false schema: type: string enum: - SCHEDULED - COMPLETED - CANCELLED - DELETED - CONFIRMED - name: sort in: query description: Which field to use when ordering the results. required: false schema: type: string - name: page in: query description: A page number within the paginated result set. required: false schema: type: integer - name: page_size in: query description: Number of results to return per page. required: false schema: type: integer responses: '200': description: Successful response for list calls. content: application/json: schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri nullable: true previous: type: string format: uri nullable: true results: type: array items: required: - call_start_time - duration_seconds - practice type: object properties: id: title: Id type: string readOnly: true minLength: 1 notes: type: array items: type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_by: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 created_at: title: Created at type: string format: date-time readOnly: true modified_by: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 modified_at: title: Modified at type: string format: date-time readOnly: true call_id: title: Call id type: string readOnly: true note: title: Note type: string readOnly: true minLength: 1 readOnly: true patients: type: array items: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true engaged_in_calls: title: Engaged in calls type: string readOnly: true assigned_agent: type: array items: required: - call type: object properties: id: title: Id type: string readOnly: true minLength: 1 agent: type: object properties: id: title: Id type: string readOnly: true minLength: 1 practice: title: Practice type: string readOnly: true user: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 call: title: Call assigned to agent type: string call_purposes: title: Call purposes type: string readOnly: true conversations: type: array items: type: object properties: caller_name: title: Caller name type: string readOnly: true current_type: title: Current type type: string enum: - static - responsive - agent readOnly: true end_time: title: End time type: string format: date-time readOnly: true nullable: true escalated_at: title: Escalated at type: string format: date-time readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 most_recent_inbound_message_time: title: Most recent inbound message time type: string format: date-time readOnly: true nullable: true most_recent_message_time: title: Most recent message time type: string format: date-time readOnly: true nullable: true opportunity_id: title: Opportunity id type: string readOnly: true origination_type: title: Origination type type: string enum: - static - responsive - agent readOnly: true patient_phone_number: title: Patient phone number type: string readOnly: true minLength: 1 nullable: true patients: type: array items: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true practice_id: title: Practice id type: string readOnly: true resolved_at: title: Resolved at type: string format: date-time readOnly: true nullable: true resolved_by: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 responsive_outreach_escalation_type: title: Responsive outreach escalation type type: string enum: - 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 readOnly: true nullable: true responsive_outreach_resolution_type: title: Responsive outreach resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true responsive_outreach_status: title: Responsive outreach status type: string enum: - working_aimee - working_agent - escalated - not_applicable - resolved_by_aimee - resolved_by_agent - closed readOnly: true start_time: title: Start time type: string format: date-time readOnly: true status: title: Status type: string enum: - open - closed readOnly: true system_phone_number: title: System phone number type: string readOnly: true minLength: 1 nullable: true resolutions: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true resolution_type: title: Resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true appointment: type: object properties: id: title: ID type: integer readOnly: true appointment_start_at: title: Appointment start at type: string format: date-time readOnly: true appointment_end_at: title: Appointment end at type: string format: date-time readOnly: true approximate_total_amount: title: Approximate total amount type: string format: decimal readOnly: true approximate_total_currency: title: Approximate total currency type: string readOnly: true minLength: 1 confirmed_at: title: Confirmed at type: string format: date-time readOnly: true nullable: true did_patient_miss: title: Did patient miss type: boolean readOnly: true nullable: true is_active: title: Is active type: boolean readOnly: true is_new_patient: title: Is new patient type: boolean readOnly: true nullable: true note: title: Note type: string readOnly: true minLength: 1 nullable: true patient_id: title: Patient id type: string readOnly: true booked_by_patient_id: title: Booked by patient id type: string readOnly: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true practice: title: Practice type: string readOnly: true procedures: title: Procedures type: string readOnly: true nullable: true status: title: Status type: string enum: - SCHEDULED - COMPLETED - CANCELLED - DELETED - CONFIRMED readOnly: true appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 duration_in_minutes: title: Duration in minutes type: integer readOnly: true practice: title: Practice type: string readOnly: true descriptors: type: array items: required: - name - code type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 code: title: Code type: string maxLength: 128 minLength: 1 active: title: Active type: boolean readOnly: true peerlogic_appointment_types: title: Peerlogic appointment types type: string readOnly: true mappings: title: Mappings type: string readOnly: true is_bookable_online: title: Is bookable online type: boolean readOnly: true is_disabled_in_peerlogic: title: Is disabled in peerlogic type: boolean readOnly: true effective_is_bookable_online: title: Effective is bookable online type: string readOnly: true has_availability_schedule: title: Has availability schedule type: boolean readOnly: true nullable: true readOnly: true booked_peerlogic_appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string enum: - Consultation - Emergency - Crown - Crown Consultation - Existing Patient Cleaning and Exam - Existing Patient Cleaning - Existing Patient Exam - >- Existing Pediatric Patient Cleaning and Exam - Existing Pediatric Patient Cleaning - Existing Pediatric Patient Exam - Extraction - Extraction Consultation - Filling - Filling Consultation - Fluoride Treatment - Implant - Implant Consultation - Invisalign Consultation - New Patient Cleaning and Exam - New Patient Cleaning - New Patient Exam - New Pediatric Patient Cleaning and Exam - New Pediatric Patient Cleaning - New Pediatric Patient Exam - Orthodontic Consultation - Periodontal Consultation - Periodontal Maintenance - Prosthodontist Consultation - Root Canal Consultation - Scaling and Root Planing - TMJ/TMD Consultation - Veneer - Veneer Consultation - Whitening - Denture - Denture Consultation - Bridge - Bridge Consultation - Cosmetic Consultation - Grooming - Vaccination - Boarding - Dental - Euthanasia - Radiology - Ultrasound - Wellness Exam - New Patient - Wellness Exam - Existing Patient - Pediatric Wellness - Technician Appointment - Sick Visit - Progress Exam - Dermatology/Allergy - Behavior Consultation - Spay - Neuter - Soft Tissue Surgery - Orthopedic Surgery - Diagnostic Imaging - Diagnostic Lab - Urgent Care - Telemedicine - Avian/Exotic Exam - Equine Field Service - Senior Wellness - Senior Wellness Exam - Geriatric Exam readOnly: true display_name: title: Display name type: string readOnly: true minLength: 1 nullable: true readOnly: true patient: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true provider: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true is_active: title: Is active type: boolean readOnly: true readOnly: true operatory: required: - name type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 display_name: title: Display name type: string maxLength: 255 nullable: true readOnly: true readOnly: true resolver_type: title: Resolver type type: string enum: - aimee - agent readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true escalations: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true escalation_type: title: Escalation type type: string enum: - 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 readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true action_required: title: Action required type: boolean readOnly: true is_action_required: title: Is action required type: string readOnly: true is_webchat: title: Is webchat type: boolean readOnly: true is_voicechat: title: Is voicechat type: boolean readOnly: true readOnly: true opportunities: type: array items: required: - conversations type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true modified_at: title: Modified at type: string format: date-time readOnly: true followed_up_at: title: Followed up at type: string format: date-time readOnly: true nullable: true is_open: title: Is open type: boolean readOnly: true status: title: Status type: string enum: - success - failure - omitted readOnly: true nullable: true trigger_type: title: Trigger type type: string enum: - 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 readOnly: true first_follow_up_call_id: title: First follow up call id type: string readOnly: true originating_call_id: title: Originating call id type: string readOnly: true originated_at: title: Originated at type: string format: date-time readOnly: true conversations: type: array items: type: object properties: caller_name: title: Caller name type: string readOnly: true current_type: title: Current type type: string enum: - static - responsive - agent readOnly: true end_time: title: End time type: string format: date-time readOnly: true nullable: true escalated_at: title: Escalated at type: string format: date-time readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 most_recent_inbound_message_time: title: Most recent inbound message time type: string format: date-time readOnly: true nullable: true most_recent_message_time: title: Most recent message time type: string format: date-time readOnly: true nullable: true opportunity_id: title: Opportunity id type: string readOnly: true origination_type: title: Origination type type: string enum: - static - responsive - agent readOnly: true patient_phone_number: title: Patient phone number type: string readOnly: true minLength: 1 nullable: true patients: type: array items: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true practice_id: title: Practice id type: string readOnly: true resolved_at: title: Resolved at type: string format: date-time readOnly: true nullable: true resolved_by: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 responsive_outreach_escalation_type: title: Responsive outreach escalation type type: string enum: - 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 readOnly: true nullable: true responsive_outreach_resolution_type: title: Responsive outreach resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true responsive_outreach_status: title: Responsive outreach status type: string enum: - working_aimee - working_agent - escalated - not_applicable - resolved_by_aimee - resolved_by_agent - closed readOnly: true start_time: title: Start time type: string format: date-time readOnly: true status: title: Status type: string enum: - open - closed readOnly: true system_phone_number: title: System phone number type: string readOnly: true minLength: 1 nullable: true resolutions: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true resolution_type: title: Resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true appointment: type: object properties: id: title: ID type: integer readOnly: true appointment_start_at: title: Appointment start at type: string format: date-time readOnly: true appointment_end_at: title: Appointment end at type: string format: date-time readOnly: true approximate_total_amount: title: Approximate total amount type: string format: decimal readOnly: true approximate_total_currency: title: Approximate total currency type: string readOnly: true minLength: 1 confirmed_at: title: Confirmed at type: string format: date-time readOnly: true nullable: true did_patient_miss: title: Did patient miss type: boolean readOnly: true nullable: true is_active: title: Is active type: boolean readOnly: true is_new_patient: title: Is new patient type: boolean readOnly: true nullable: true note: title: Note type: string readOnly: true minLength: 1 nullable: true patient_id: title: Patient id type: string readOnly: true booked_by_patient_id: title: Booked by patient id type: string readOnly: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true practice: title: Practice type: string readOnly: true procedures: title: Procedures type: string readOnly: true nullable: true status: title: Status type: string enum: - SCHEDULED - COMPLETED - CANCELLED - DELETED - CONFIRMED readOnly: true appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 duration_in_minutes: title: Duration in minutes type: integer readOnly: true practice: title: Practice type: string readOnly: true descriptors: type: array items: required: - name - code type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 code: title: Code type: string maxLength: 128 minLength: 1 active: title: Active type: boolean readOnly: true peerlogic_appointment_types: title: Peerlogic appointment types type: string readOnly: true mappings: title: Mappings type: string readOnly: true is_bookable_online: title: Is bookable online type: boolean readOnly: true is_disabled_in_peerlogic: title: Is disabled in peerlogic type: boolean readOnly: true effective_is_bookable_online: title: Effective is bookable online type: string readOnly: true has_availability_schedule: title: Has availability schedule type: boolean readOnly: true nullable: true readOnly: true booked_peerlogic_appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string enum: - Consultation - Emergency - Crown - Crown Consultation - Existing Patient Cleaning and Exam - Existing Patient Cleaning - Existing Patient Exam - >- Existing Pediatric Patient Cleaning and Exam - Existing Pediatric Patient Cleaning - Existing Pediatric Patient Exam - Extraction - Extraction Consultation - Filling - Filling Consultation - Fluoride Treatment - Implant - Implant Consultation - Invisalign Consultation - New Patient Cleaning and Exam - New Patient Cleaning - New Patient Exam - New Pediatric Patient Cleaning and Exam - New Pediatric Patient Cleaning - New Pediatric Patient Exam - Orthodontic Consultation - Periodontal Consultation - Periodontal Maintenance - Prosthodontist Consultation - Root Canal Consultation - Scaling and Root Planing - TMJ/TMD Consultation - Veneer - Veneer Consultation - Whitening - Denture - Denture Consultation - Bridge - Bridge Consultation - Cosmetic Consultation - Grooming - Vaccination - Boarding - Dental - Euthanasia - Radiology - Ultrasound - Wellness Exam - New Patient - Wellness Exam - Existing Patient - Pediatric Wellness - Technician Appointment - Sick Visit - Progress Exam - Dermatology/Allergy - Behavior Consultation - Spay - Neuter - Soft Tissue Surgery - Orthopedic Surgery - Diagnostic Imaging - Diagnostic Lab - Urgent Care - Telemedicine - Avian/Exotic Exam - Equine Field Service - Senior Wellness - Senior Wellness Exam - Geriatric Exam readOnly: true display_name: title: Display name type: string readOnly: true minLength: 1 nullable: true readOnly: true patient: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true provider: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true is_active: title: Is active type: boolean readOnly: true readOnly: true operatory: required: - name type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 display_name: title: Display name type: string maxLength: 255 nullable: true readOnly: true readOnly: true resolver_type: title: Resolver type type: string enum: - aimee - agent readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true escalations: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true escalation_type: title: Escalation type type: string enum: - 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 readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true action_required: title: Action required type: boolean readOnly: true is_action_required: title: Is action required type: string readOnly: true is_webchat: title: Is webchat type: boolean readOnly: true is_voicechat: title: Is voicechat type: boolean readOnly: true has_any_follow_up: title: Has any follow up type: boolean readOnly: true follow_ups: type: array items: type: object properties: id: title: ID type: integer readOnly: true call_id: title: Call id type: string readOnly: true minLength: 1 call_direction: title: Call direction type: string readOnly: true minLength: 1 call_connection: title: Call connection type: string readOnly: true minLength: 1 call_start_time: title: Call start time type: string format: date-time readOnly: true readOnly: true readOnly: true precedent_opportunities: title: Precedent opportunities type: string readOnly: true mentioned_companies: title: Mentioned companies type: string readOnly: true mentioned_insurances: title: Mentioned insurances type: string readOnly: true mentioned_procedures: title: Mentioned procedures type: string readOnly: true mentioned_products: title: Mentioned products type: string readOnly: true mentioned_symptoms: title: Mentioned symptoms type: string readOnly: true has_audio: title: Has audio type: string readOnly: true has_transcript: title: Has transcript type: string readOnly: true latest_audio_waveform_data: title: Latest audio waveform data type: string readOnly: true call_sentiments: type: array items: required: - callee_sentiment_score type: object properties: id: title: Id type: string readOnly: true minLength: 1 overall_sentiment_score: title: Overall sentiment score type: string enum: - positive - neutral - negative - not_applicable readOnly: true caller_sentiment_score: title: Caller sentiment score type: string enum: - positive - neutral - negative - not_applicable readOnly: true callee_sentiment_score: title: Callee sentiment score type: string enum: - positive - neutral - negative - not_applicable readOnly: true total_value: title: Total value type: string readOnly: true domain: title: Domain type: string minLength: 1 booking_status: title: Booking status type: string readOnly: true reasons_not_booked: title: Reasons not booked type: string readOnly: true marketing_campaign_name: title: Marketing campaign name type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true modified_at: title: Modified at type: string format: date-time readOnly: true call_start_time: title: Call start time type: string format: date-time call_end_time: title: Call end time type: string format: date-time nullable: true duration_seconds: title: Duration seconds type: string connect_duration_seconds: title: Connect duration seconds type: string nullable: true progress_time_seconds: title: Progress time seconds type: string nullable: true hold_time_seconds: title: Hold time seconds type: string nullable: true call_direction: title: Call direction type: string enum: - inbound - outbound - internal sip_caller_extension: title: Sip caller extension type: string maxLength: 60 sip_caller_number: title: Sip caller number type: string maxLength: 128 sip_caller_name: title: Sip caller name type: string maxLength: 255 sip_callee_extension: title: Sip callee extension type: string maxLength: 60 sip_callee_number: title: Sip callee number type: string maxLength: 128 sip_callee_name: title: Sip callee name type: string maxLength: 255 sip_term_number: title: Sip term number type: string maxLength: 128 checked_voicemail: title: Checked voicemail type: boolean nullable: true went_to_voicemail: title: Went to voicemail type: boolean nullable: true call_connection: title: Call connection type: string enum: - missed - connected who_terminated_call: title: Who terminated call type: string enum: - caller - callee referral_source: title: Referral source type: string enum: - patient_referral - medical_provider - dental_provider - web_search - social_media - insurance - paid_advertising - not_applicable - others caller_type: title: Caller type type: string enum: - agent - non_agent callee_type: title: Callee type type: string enum: - agent - non_agent is_routed_to_aimee_voice: title: Is routed to aimee voice type: boolean created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true modified_by: title: The user that is automatically assigned type: string readOnly: true nullable: true practice: title: The practice that made or received the call type: string practice_telecom: title: Practice telecom description: >- The specific practice telecom connected with VoIP provider, that made or received the call type: string nullable: true caller_id: title: Caller id type: string nullable: true callee_id: title: Callee id type: string nullable: true text/csv: schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri nullable: true previous: type: string format: uri nullable: true results: type: array items: required: - call_start_time - duration_seconds - practice type: object properties: id: title: Id type: string readOnly: true minLength: 1 notes: type: array items: type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_by: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 created_at: title: Created at type: string format: date-time readOnly: true modified_by: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 modified_at: title: Modified at type: string format: date-time readOnly: true call_id: title: Call id type: string readOnly: true note: title: Note type: string readOnly: true minLength: 1 readOnly: true patients: type: array items: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true engaged_in_calls: title: Engaged in calls type: string readOnly: true assigned_agent: type: array items: required: - call type: object properties: id: title: Id type: string readOnly: true minLength: 1 agent: type: object properties: id: title: Id type: string readOnly: true minLength: 1 practice: title: Practice type: string readOnly: true user: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 call: title: Call assigned to agent type: string call_purposes: title: Call purposes type: string readOnly: true conversations: type: array items: type: object properties: caller_name: title: Caller name type: string readOnly: true current_type: title: Current type type: string enum: - static - responsive - agent readOnly: true end_time: title: End time type: string format: date-time readOnly: true nullable: true escalated_at: title: Escalated at type: string format: date-time readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 most_recent_inbound_message_time: title: Most recent inbound message time type: string format: date-time readOnly: true nullable: true most_recent_message_time: title: Most recent message time type: string format: date-time readOnly: true nullable: true opportunity_id: title: Opportunity id type: string readOnly: true origination_type: title: Origination type type: string enum: - static - responsive - agent readOnly: true patient_phone_number: title: Patient phone number type: string readOnly: true minLength: 1 nullable: true patients: type: array items: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true practice_id: title: Practice id type: string readOnly: true resolved_at: title: Resolved at type: string format: date-time readOnly: true nullable: true resolved_by: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 responsive_outreach_escalation_type: title: Responsive outreach escalation type type: string enum: - 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 readOnly: true nullable: true responsive_outreach_resolution_type: title: Responsive outreach resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true responsive_outreach_status: title: Responsive outreach status type: string enum: - working_aimee - working_agent - escalated - not_applicable - resolved_by_aimee - resolved_by_agent - closed readOnly: true start_time: title: Start time type: string format: date-time readOnly: true status: title: Status type: string enum: - open - closed readOnly: true system_phone_number: title: System phone number type: string readOnly: true minLength: 1 nullable: true resolutions: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true resolution_type: title: Resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true appointment: type: object properties: id: title: ID type: integer readOnly: true appointment_start_at: title: Appointment start at type: string format: date-time readOnly: true appointment_end_at: title: Appointment end at type: string format: date-time readOnly: true approximate_total_amount: title: Approximate total amount type: string format: decimal readOnly: true approximate_total_currency: title: Approximate total currency type: string readOnly: true minLength: 1 confirmed_at: title: Confirmed at type: string format: date-time readOnly: true nullable: true did_patient_miss: title: Did patient miss type: boolean readOnly: true nullable: true is_active: title: Is active type: boolean readOnly: true is_new_patient: title: Is new patient type: boolean readOnly: true nullable: true note: title: Note type: string readOnly: true minLength: 1 nullable: true patient_id: title: Patient id type: string readOnly: true booked_by_patient_id: title: Booked by patient id type: string readOnly: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true practice: title: Practice type: string readOnly: true procedures: title: Procedures type: string readOnly: true nullable: true status: title: Status type: string enum: - SCHEDULED - COMPLETED - CANCELLED - DELETED - CONFIRMED readOnly: true appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 duration_in_minutes: title: Duration in minutes type: integer readOnly: true practice: title: Practice type: string readOnly: true descriptors: type: array items: required: - name - code type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 code: title: Code type: string maxLength: 128 minLength: 1 active: title: Active type: boolean readOnly: true peerlogic_appointment_types: title: Peerlogic appointment types type: string readOnly: true mappings: title: Mappings type: string readOnly: true is_bookable_online: title: Is bookable online type: boolean readOnly: true is_disabled_in_peerlogic: title: Is disabled in peerlogic type: boolean readOnly: true effective_is_bookable_online: title: Effective is bookable online type: string readOnly: true has_availability_schedule: title: Has availability schedule type: boolean readOnly: true nullable: true readOnly: true booked_peerlogic_appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string enum: - Consultation - Emergency - Crown - Crown Consultation - Existing Patient Cleaning and Exam - Existing Patient Cleaning - Existing Patient Exam - >- Existing Pediatric Patient Cleaning and Exam - Existing Pediatric Patient Cleaning - Existing Pediatric Patient Exam - Extraction - Extraction Consultation - Filling - Filling Consultation - Fluoride Treatment - Implant - Implant Consultation - Invisalign Consultation - New Patient Cleaning and Exam - New Patient Cleaning - New Patient Exam - New Pediatric Patient Cleaning and Exam - New Pediatric Patient Cleaning - New Pediatric Patient Exam - Orthodontic Consultation - Periodontal Consultation - Periodontal Maintenance - Prosthodontist Consultation - Root Canal Consultation - Scaling and Root Planing - TMJ/TMD Consultation - Veneer - Veneer Consultation - Whitening - Denture - Denture Consultation - Bridge - Bridge Consultation - Cosmetic Consultation - Grooming - Vaccination - Boarding - Dental - Euthanasia - Radiology - Ultrasound - Wellness Exam - New Patient - Wellness Exam - Existing Patient - Pediatric Wellness - Technician Appointment - Sick Visit - Progress Exam - Dermatology/Allergy - Behavior Consultation - Spay - Neuter - Soft Tissue Surgery - Orthopedic Surgery - Diagnostic Imaging - Diagnostic Lab - Urgent Care - Telemedicine - Avian/Exotic Exam - Equine Field Service - Senior Wellness - Senior Wellness Exam - Geriatric Exam readOnly: true display_name: title: Display name type: string readOnly: true minLength: 1 nullable: true readOnly: true patient: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true provider: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true is_active: title: Is active type: boolean readOnly: true readOnly: true operatory: required: - name type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 display_name: title: Display name type: string maxLength: 255 nullable: true readOnly: true readOnly: true resolver_type: title: Resolver type type: string enum: - aimee - agent readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true escalations: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true escalation_type: title: Escalation type type: string enum: - 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 readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true action_required: title: Action required type: boolean readOnly: true is_action_required: title: Is action required type: string readOnly: true is_webchat: title: Is webchat type: boolean readOnly: true is_voicechat: title: Is voicechat type: boolean readOnly: true readOnly: true opportunities: type: array items: required: - conversations type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true modified_at: title: Modified at type: string format: date-time readOnly: true followed_up_at: title: Followed up at type: string format: date-time readOnly: true nullable: true is_open: title: Is open type: boolean readOnly: true status: title: Status type: string enum: - success - failure - omitted readOnly: true nullable: true trigger_type: title: Trigger type type: string enum: - 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 readOnly: true first_follow_up_call_id: title: First follow up call id type: string readOnly: true originating_call_id: title: Originating call id type: string readOnly: true originated_at: title: Originated at type: string format: date-time readOnly: true conversations: type: array items: type: object properties: caller_name: title: Caller name type: string readOnly: true current_type: title: Current type type: string enum: - static - responsive - agent readOnly: true end_time: title: End time type: string format: date-time readOnly: true nullable: true escalated_at: title: Escalated at type: string format: date-time readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 most_recent_inbound_message_time: title: Most recent inbound message time type: string format: date-time readOnly: true nullable: true most_recent_message_time: title: Most recent message time type: string format: date-time readOnly: true nullable: true opportunity_id: title: Opportunity id type: string readOnly: true origination_type: title: Origination type type: string enum: - static - responsive - agent readOnly: true patient_phone_number: title: Patient phone number type: string readOnly: true minLength: 1 nullable: true patients: type: array items: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true practice_id: title: Practice id type: string readOnly: true resolved_at: title: Resolved at type: string format: date-time readOnly: true nullable: true resolved_by: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 responsive_outreach_escalation_type: title: Responsive outreach escalation type type: string enum: - 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 readOnly: true nullable: true responsive_outreach_resolution_type: title: Responsive outreach resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true responsive_outreach_status: title: Responsive outreach status type: string enum: - working_aimee - working_agent - escalated - not_applicable - resolved_by_aimee - resolved_by_agent - closed readOnly: true start_time: title: Start time type: string format: date-time readOnly: true status: title: Status type: string enum: - open - closed readOnly: true system_phone_number: title: System phone number type: string readOnly: true minLength: 1 nullable: true resolutions: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true resolution_type: title: Resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true appointment: type: object properties: id: title: ID type: integer readOnly: true appointment_start_at: title: Appointment start at type: string format: date-time readOnly: true appointment_end_at: title: Appointment end at type: string format: date-time readOnly: true approximate_total_amount: title: Approximate total amount type: string format: decimal readOnly: true approximate_total_currency: title: Approximate total currency type: string readOnly: true minLength: 1 confirmed_at: title: Confirmed at type: string format: date-time readOnly: true nullable: true did_patient_miss: title: Did patient miss type: boolean readOnly: true nullable: true is_active: title: Is active type: boolean readOnly: true is_new_patient: title: Is new patient type: boolean readOnly: true nullable: true note: title: Note type: string readOnly: true minLength: 1 nullable: true patient_id: title: Patient id type: string readOnly: true booked_by_patient_id: title: Booked by patient id type: string readOnly: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true practice: title: Practice type: string readOnly: true procedures: title: Procedures type: string readOnly: true nullable: true status: title: Status type: string enum: - SCHEDULED - COMPLETED - CANCELLED - DELETED - CONFIRMED readOnly: true appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 duration_in_minutes: title: Duration in minutes type: integer readOnly: true practice: title: Practice type: string readOnly: true descriptors: type: array items: required: - name - code type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 code: title: Code type: string maxLength: 128 minLength: 1 active: title: Active type: boolean readOnly: true peerlogic_appointment_types: title: Peerlogic appointment types type: string readOnly: true mappings: title: Mappings type: string readOnly: true is_bookable_online: title: Is bookable online type: boolean readOnly: true is_disabled_in_peerlogic: title: Is disabled in peerlogic type: boolean readOnly: true effective_is_bookable_online: title: Effective is bookable online type: string readOnly: true has_availability_schedule: title: Has availability schedule type: boolean readOnly: true nullable: true readOnly: true booked_peerlogic_appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string enum: - Consultation - Emergency - Crown - Crown Consultation - Existing Patient Cleaning and Exam - Existing Patient Cleaning - Existing Patient Exam - >- Existing Pediatric Patient Cleaning and Exam - Existing Pediatric Patient Cleaning - Existing Pediatric Patient Exam - Extraction - Extraction Consultation - Filling - Filling Consultation - Fluoride Treatment - Implant - Implant Consultation - Invisalign Consultation - New Patient Cleaning and Exam - New Patient Cleaning - New Patient Exam - New Pediatric Patient Cleaning and Exam - New Pediatric Patient Cleaning - New Pediatric Patient Exam - Orthodontic Consultation - Periodontal Consultation - Periodontal Maintenance - Prosthodontist Consultation - Root Canal Consultation - Scaling and Root Planing - TMJ/TMD Consultation - Veneer - Veneer Consultation - Whitening - Denture - Denture Consultation - Bridge - Bridge Consultation - Cosmetic Consultation - Grooming - Vaccination - Boarding - Dental - Euthanasia - Radiology - Ultrasound - Wellness Exam - New Patient - Wellness Exam - Existing Patient - Pediatric Wellness - Technician Appointment - Sick Visit - Progress Exam - Dermatology/Allergy - Behavior Consultation - Spay - Neuter - Soft Tissue Surgery - Orthopedic Surgery - Diagnostic Imaging - Diagnostic Lab - Urgent Care - Telemedicine - Avian/Exotic Exam - Equine Field Service - Senior Wellness - Senior Wellness Exam - Geriatric Exam readOnly: true display_name: title: Display name type: string readOnly: true minLength: 1 nullable: true readOnly: true patient: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true provider: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true is_active: title: Is active type: boolean readOnly: true readOnly: true operatory: required: - name type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 display_name: title: Display name type: string maxLength: 255 nullable: true readOnly: true readOnly: true resolver_type: title: Resolver type type: string enum: - aimee - agent readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true escalations: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true escalation_type: title: Escalation type type: string enum: - 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 readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true action_required: title: Action required type: boolean readOnly: true is_action_required: title: Is action required type: string readOnly: true is_webchat: title: Is webchat type: boolean readOnly: true is_voicechat: title: Is voicechat type: boolean readOnly: true has_any_follow_up: title: Has any follow up type: boolean readOnly: true follow_ups: type: array items: type: object properties: id: title: ID type: integer readOnly: true call_id: title: Call id type: string readOnly: true minLength: 1 call_direction: title: Call direction type: string readOnly: true minLength: 1 call_connection: title: Call connection type: string readOnly: true minLength: 1 call_start_time: title: Call start time type: string format: date-time readOnly: true readOnly: true readOnly: true precedent_opportunities: title: Precedent opportunities type: string readOnly: true mentioned_companies: title: Mentioned companies type: string readOnly: true mentioned_insurances: title: Mentioned insurances type: string readOnly: true mentioned_procedures: title: Mentioned procedures type: string readOnly: true mentioned_products: title: Mentioned products type: string readOnly: true mentioned_symptoms: title: Mentioned symptoms type: string readOnly: true has_audio: title: Has audio type: string readOnly: true has_transcript: title: Has transcript type: string readOnly: true latest_audio_waveform_data: title: Latest audio waveform data type: string readOnly: true call_sentiments: type: array items: required: - callee_sentiment_score type: object properties: id: title: Id type: string readOnly: true minLength: 1 overall_sentiment_score: title: Overall sentiment score type: string enum: - positive - neutral - negative - not_applicable readOnly: true caller_sentiment_score: title: Caller sentiment score type: string enum: - positive - neutral - negative - not_applicable readOnly: true callee_sentiment_score: title: Callee sentiment score type: string enum: - positive - neutral - negative - not_applicable readOnly: true total_value: title: Total value type: string readOnly: true domain: title: Domain type: string minLength: 1 booking_status: title: Booking status type: string readOnly: true reasons_not_booked: title: Reasons not booked type: string readOnly: true marketing_campaign_name: title: Marketing campaign name type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true modified_at: title: Modified at type: string format: date-time readOnly: true call_start_time: title: Call start time type: string format: date-time call_end_time: title: Call end time type: string format: date-time nullable: true duration_seconds: title: Duration seconds type: string connect_duration_seconds: title: Connect duration seconds type: string nullable: true progress_time_seconds: title: Progress time seconds type: string nullable: true hold_time_seconds: title: Hold time seconds type: string nullable: true call_direction: title: Call direction type: string enum: - inbound - outbound - internal sip_caller_extension: title: Sip caller extension type: string maxLength: 60 sip_caller_number: title: Sip caller number type: string maxLength: 128 sip_caller_name: title: Sip caller name type: string maxLength: 255 sip_callee_extension: title: Sip callee extension type: string maxLength: 60 sip_callee_number: title: Sip callee number type: string maxLength: 128 sip_callee_name: title: Sip callee name type: string maxLength: 255 sip_term_number: title: Sip term number type: string maxLength: 128 checked_voicemail: title: Checked voicemail type: boolean nullable: true went_to_voicemail: title: Went to voicemail type: boolean nullable: true call_connection: title: Call connection type: string enum: - missed - connected who_terminated_call: title: Who terminated call type: string enum: - caller - callee referral_source: title: Referral source type: string enum: - patient_referral - medical_provider - dental_provider - web_search - social_media - insurance - paid_advertising - not_applicable - others caller_type: title: Caller type type: string enum: - agent - non_agent callee_type: title: Callee type type: string enum: - agent - non_agent is_routed_to_aimee_voice: title: Is routed to aimee voice type: boolean created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true modified_by: title: The user that is automatically assigned type: string readOnly: true nullable: true practice: title: The practice that made or received the call type: string practice_telecom: title: Practice telecom description: >- The specific practice telecom connected with VoIP provider, that made or received the call type: string nullable: true caller_id: title: Caller id type: string nullable: true callee_id: title: Callee id type: string nullable: true '400': description: The request parameters or body are invalid. content: application/json: schema: $ref: '#/components/schemas/ValidationError' example: sort: - Select a valid choice. '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' example: detail: '''Authorization'' header is required' '403': description: >- The authenticated account does not have permission to perform this operation. content: application/json: schema: $ref: '#/components/schemas/PermissionError' example: message: No permissions assigned to permit access to this endpoint. security: - bearerAuth: [] components: schemas: ValidationError: title: Validation error type: object additionalProperties: true description: Validation details keyed by the invalid field or grouped under `errors`. AuthenticationError: title: Authentication error type: object additionalProperties: true required: - detail properties: detail: type: string description: Why authentication failed. PermissionError: title: Permission error type: object additionalProperties: false required: - message properties: message: type: string description: Why access was denied. securitySchemes: bearerAuth: type: http scheme: bearer description: Bearer access token issued by Peerlogic. ```` ## Related topics - [List call purposes](/peerlogic-api-reference/transcripts/list-call-purposes.md) - [List call sentiments](/peerlogic-api-reference/transcripts/list-call-sentiments.md) - [List call outcomes](/peerlogic-api-reference/transcripts/list-call-outcomes.md) - [List call pauses](/peerlogic-api-reference/transcripts/list-call-pauses.md) - [List call recordings](/peerlogic-api-reference/call-recordings/list-call-recordings.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.