> ## 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 Aimee conversations > Retrieve a Paginated List of Conversations. **Sample Request:** ``` GET /api/aimee-conversation/?practice_ids=9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2&organization_id=9AxAFr4n63uputNXKo89x1®ion_id=9AxAFr4n63uputNXKo89x1&search=follow-up&caller_name=John+Doe&start_time=2024-09-25T08:00:00Z&non_practice_participant_type=new_patient&custom_filter=aimee_booked&sort_by=-start_time&page_size=50&page=1 ``` ## OpenAPI ````yaml /openapi/peerlogic-api.json get /api/aimee-conversation/ 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/aimee-conversation/: parameters: [] get: tags: - Aimee summary: List Aimee conversations description: >- Retrieve a Paginated List of Conversations. **Sample Request:** ``` GET /api/aimee-conversation/?practice_ids=9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2&organization_id=9AxAFr4n63uputNXKo89x1®ion_id=9AxAFr4n63uputNXKo89x1&search=follow-up&caller_name=John+Doe&start_time=2024-09-25T08:00:00Z&non_practice_participant_type=new_patient&custom_filter=aimee_booked&sort_by=-start_time&page_size=50&page=1 ``` operationId: aimee-conversation_list parameters: - name: practice_ids in: query description: >- Comma-separated list of practice IDs to filter conversations by specific practices. Example: '9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2' required: false schema: type: string - name: organization_id in: query description: >- Organization ID to filter conversations within a specific organization. Example: '9AxAFr4n63uputNXKo89x1' required: false schema: type: string - name: region_id in: query description: >- Region ID to filter conversations by a specific region. Example: '9AxAFr4n63uputNXKo89x1' required: false schema: type: string - name: search in: query description: >- Search term to filter conversations by message content. Example: 'follow-up' required: false schema: type: string - name: caller_name in: query description: 'Filter conversations by caller name. Example: ''John Doe''' required: false schema: type: string - name: start_time in: query description: 'Filter conversations by start time. Example: ''2024-09-25T08:00:00Z''' required: false schema: type: string - name: non_practice_participant_type in: query description: >- Filter conversations by non-practice participant type. Example: 'new_patient'. required: false schema: type: string enum: - new_patient - existing_patient - name: responsive_outreach_status in: query description: >- Filter conversations by responsive outreach status. Example: 'working_aimee'. required: false schema: type: string enum: - working_aimee - working_agent - escalated - not_applicable - resolved_by_aimee - resolved_by_agent - closed - name: responsive_outreach_escalation_type in: query description: >- Filter conversations by responsive outreach escalation. Example: 'aimee_initiated'. required: false schema: 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 - name: custom_filter in: query description: 'Apply custom filters to conversations. Example: ''aimee_booked''.' required: false schema: type: string enum: - all_conversations - patients_engaged - action_required - aimee_booked - aimee_rescheduled - aimee_cancelled - aimee_confirmed - staff_intervened - staff_booked - staff_rescheduled - staff_cancelled - staff_confirmed - name: sort_by in: query description: >- 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. required: false schema: type: string default: '-start_time' - name: page_size in: query description: >- Number of results to return per page. Defaults to the system-wide pagination settings if not provided. i.e: 50 required: false schema: type: integer - name: page in: query description: Page number to return. Defaults to the first page if not provided. required: false schema: type: integer responses: '200': description: A list of conversations. content: application/json: schema: type: array items: required: - caller_phone - date_time type: object properties: action_required: title: Action required type: boolean readOnly: true caller_name: title: Caller name type: string readOnly: true caller_phone: title: Caller phone type: string minLength: 1 current_type: title: Current type type: string enum: - static - responsive - agent readOnly: true date_time: title: Date time type: string format: date-time 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 id: title: Id type: string readOnly: true minLength: 1 is_action_required: title: Is action required type: string readOnly: true non_practice_participant_type: title: Non practice participant type type: string readOnly: true opportunity: title: Opportunity type: string readOnly: true nullable: true opportunity_status: title: Opportunity status type: string readOnly: true origination_type: title: Origination type type: string enum: - static - responsive - agent 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 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 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 status: title: Status type: string enum: - open - closed readOnly: true is_webchat: title: Is webchat type: boolean readOnly: true is_voicechat: title: Is voicechat type: boolean readOnly: true examples: response: value: meta: page: 1 page_total: 54 page_size: 50 results_total: 2696 links: previous: null self: >- https://api.{environment}.peerlogic.com/api/aimee-conversation/?practice_id=Ewq92UokfUaqgV2KihWirR next: >- https://api.{environment}.peerlogic.com/api/aimee-conversation/?page=2&practice_id=Ewq92UokfUaqgV2KihWirR results: - id: 9AxAFr4n63uputNXKo89W2 date_time: '2024-09-25T17:06:01.887165-07:00' caller_name: John Doe caller_phone: '+16023030000' opportunity_status: booked responsive_outreach_resolution_type: booked resolutions: - id: aeRiKcbVDwcFLvpiupTHrn created_at: '2024-09-25T13:25:52.966771-07:00' resolution_type: booked - id: AfRqcLmujyiMWu96qP5uze created_at: '2024-09-25T13:24:33.041221-07:00' resolution_type: cancelled non_practice_participant_type: new_patient opportunity: ZWriUzHDX6CutF9wfLNxvx origination_type: responsive responsive_outreach_status: working_aimee action_required: false '400': description: Bad Request - Invalid parameters. content: application/json: schema: $ref: '#/components/schemas/ValidationError' example: field_error: >- One of the following parameter must be provided [practice_ids, organization_id or region_id] '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' example: detail: '''Authorization'' header is required' 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. securitySchemes: bearerAuth: type: http scheme: bearer description: Bearer access token issued by Peerlogic. ```` ## Related topics - [List conversations](/peerlogic-api-reference/conversations/list-conversations.md) - [List conversation messages](/peerlogic-api-reference/conversations/list-conversation-messages.md) - [List paginated conversation messages](/peerlogic-api-reference/conversations/list-paginated-conversation-messages.md) - [List available Aimee call types](/peerlogic-api-reference/aimee/list-available-aimee-call-types.md) - [List patient call history](/peerlogic-api-reference/contacts-and-patients/list-patient-call-history.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.