> ## 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 events

> Events are the queryable history of significant call and engagement activity recognized by Peerlogic. Use this endpoint to reconcile webhook-driven workflows, build operational queues, or retrieve related call and opportunity context after receiving a notification.

Use subscriptions when your integration needs activity pushed to it as it occurs. Use this event collection when your integration needs to search, filter, or revisit recorded activity. `practice_id` is required and scopes the results to a practice your account can access.

An event can contain related call and opportunity summaries. Treat their identifiers as links to the corresponding API resources when you need the latest or more detailed representation.



## OpenAPI

````yaml /openapi/peerlogic-api.json get /api/events/
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/events/:
    parameters: []
    get:
      tags:
        - Subscriptions and events
      summary: List events
      description: >-
        Events are the queryable history of significant call and engagement
        activity recognized by Peerlogic. Use this endpoint to reconcile
        webhook-driven workflows, build operational queues, or retrieve related
        call and opportunity context after receiving a notification.


        Use subscriptions when your integration needs activity pushed to it as
        it occurs. Use this event collection when your integration needs to
        search, filter, or revisit recorded activity. `practice_id` is required
        and scopes the results to a practice your account can access.


        An event can contain related call and opportunity summaries. Treat their
        identifiers as links to the corresponding API resources when you need
        the latest or more detailed representation.
      operationId: events_list
      parameters:
        - name: id
          in: query
          description: Return a specific event ID.
          required: false
          schema:
            type: string
        - name: call_id
          in: query
          description: Return events associated with a specific call ID.
          required: false
          schema:
            type: string
        - name: call__practice_id
          in: query
          description: Legacy practice filter. Use `practice_id` for new integrations.
          required: false
          schema:
            type: string
        - name: call__call_direction
          in: query
          description: Return events for inbound, outbound, or internal calls.
          required: false
          schema:
            type: string
            enum:
              - inbound
              - outbound
              - internal
        - name: call__call_connection
          in: query
          description: Return events for missed or connected calls.
          required: false
          schema:
            type: string
            enum:
              - missed
              - connected
        - name: call__went_to_voicemail
          in: query
          description: >-
            Set to `true` or `false` to filter by whether the call reached
            voicemail.
          required: false
          schema:
            type: boolean
        - name: call__checked_voicemail
          in: query
          description: >-
            Set to `true` or `false` to filter by whether the voicemail was
            checked.
          required: false
          schema:
            type: boolean
        - name: trigger_type
          in: query
          description: Return events produced by this trigger type.
          required: false
          schema:
            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
        - name: is_significant
          in: query
          description: >-
            Set to `true` or `false` to filter by whether Peerlogic marked the
            event as significant.
          required: false
          schema:
            type: boolean
        - name: call__call_start_time
          in: query
          description: >-
            Limit results by call start time using the supported date or
            date-time range syntax.
          required: false
          schema:
            type: string
        - name: is_followed_up
          in: query
          description: >-
            Set to `true` or `false` to filter by whether the related
            opportunity has been followed up.
          required: false
          schema:
            type: boolean
        - name: is_open
          in: query
          description: >-
            Set to `true` or `false` to filter by whether the related
            opportunity remains open.
          required: false
          schema:
            type: boolean
        - name: status
          in: query
          description: Filter by the outcome status of the related opportunity.
          required: false
          schema:
            type: string
            enum:
              - success
              - failure
              - omitted
        - name: practice_id
          in: query
          description: Required. Return events for this practice ID.
          required: true
          schema:
            type: string
        - name: name_any
          in: query
          description: >-
            Search caller, callee, contact, and patient names associated with
            the event.
          required: false
          schema:
            type: string
        - name: sort
          in: query
          description: >-
            Order results by a supported event field. Prefix a field with `-`
            for descending order.
          required: false
          schema:
            type: string
        - name: page
          in: query
          description: Page number to return.
          required: false
          schema:
            type: integer
        - name: page_size
          in: query
          description: Maximum number of events to return on one page.
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: Successful response for list events.
          content:
            application/json:
              schema:
                required:
                  - count
                  - results
                type: object
                properties:
                  count:
                    type: integer
                    description: Total number of matching events.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL for the next page, or `null` when this is the final
                      page.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL for the previous page, or `null` when this is the
                      first page.
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        call:
                          type: object
                          properties:
                            call_connection:
                              title: Call connection
                              type: string
                              enum:
                                - missed
                                - connected
                              readOnly: true
                              description: Whether the call was connected or missed.
                            call_direction:
                              title: Call direction
                              type: string
                              enum:
                                - inbound
                                - outbound
                                - internal
                              readOnly: true
                              description: Direction of the call.
                            call_end_time:
                              title: Call end time
                              type: string
                              format: date-time
                              readOnly: true
                              nullable: true
                              description: Time when the call ended, when available.
                            call_start_time:
                              title: Call start time
                              type: string
                              format: date-time
                              readOnly: true
                              description: Time when the call started.
                            callee_id:
                              title: Callee id
                              type: string
                              readOnly: true
                              nullable: true
                              description: >-
                                Called telephone number or identifier, when
                                available.
                            caller_id:
                              title: Caller id
                              type: string
                              readOnly: true
                              nullable: true
                              description: >-
                                Caller telephone number or identifier, when
                                available.
                            checked_voicemail:
                              title: Checked voicemail
                              type: boolean
                              readOnly: true
                              nullable: true
                              description: Whether the voicemail was checked.
                            connect_duration_seconds:
                              title: Connect duration seconds
                              type: string
                              readOnly: true
                              nullable: true
                              description: >-
                                Connected portion of the call in seconds, when
                                available.
                            duration_seconds:
                              title: Duration seconds
                              type: string
                              readOnly: true
                              description: Total call duration in seconds.
                            hold_time_seconds:
                              title: Hold time seconds
                              type: string
                              readOnly: true
                              nullable: true
                              description: Time spent on hold in seconds, when available.
                            id:
                              title: Id
                              type: string
                              readOnly: true
                              minLength: 1
                              description: Unique identifier for this resource.
                            non_agent_persona_type:
                              title: Non agent persona type
                              type: string
                              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
                                    description: Unique identifier for this resource.
                                  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
                              description: >-
                                Patient records associated with the call, when
                                available.
                            practice_id:
                              title: Practice id
                              type: string
                              readOnly: true
                            progress_time_seconds:
                              title: Progress time seconds
                              type: string
                              readOnly: true
                              nullable: true
                            referral_source:
                              title: Referral source
                              type: string
                              enum:
                                - patient_referral
                                - medical_provider
                                - dental_provider
                                - web_search
                                - social_media
                                - insurance
                                - paid_advertising
                                - not_applicable
                                - others
                              readOnly: true
                            sip_callee_extension:
                              title: Sip callee extension
                              type: string
                              readOnly: true
                              minLength: 1
                            sip_callee_name:
                              title: Sip callee name
                              type: string
                              readOnly: true
                              minLength: 1
                            sip_callee_number:
                              title: Sip callee number
                              type: string
                              readOnly: true
                              minLength: 1
                            sip_caller_extension:
                              title: Sip caller extension
                              type: string
                              readOnly: true
                              minLength: 1
                            sip_caller_name:
                              title: Sip caller name
                              type: string
                              readOnly: true
                              minLength: 1
                            sip_caller_number:
                              title: Sip caller number
                              type: string
                              readOnly: true
                              minLength: 1
                            went_to_voicemail:
                              title: Went to voicemail
                              type: boolean
                              readOnly: true
                              nullable: true
                              description: Whether the call reached voicemail.
                            who_terminated_call:
                              title: Who terminated call
                              type: string
                              enum:
                                - caller
                                - callee
                              readOnly: true
                          readOnly: true
                          description: Call context associated with the event.
                        first_follow_up_call:
                          title: First follow up call
                          type: string
                          readOnly: true
                          description: >-
                            First follow-up call associated with the
                            opportunity, when available.
                        created_at:
                          title: Created at
                          type: string
                          format: date-time
                          readOnly: true
                          description: Time when Peerlogic created the event record.
                        followed_up_at:
                          title: Followed up at
                          type: string
                          readOnly: true
                          description: >-
                            Time when the related opportunity was followed up,
                            when available.
                        id:
                          title: Id
                          type: string
                          readOnly: true
                          minLength: 1
                          description: Unique identifier for this resource.
                        is_followed_up:
                          title: Is followed up
                          type: string
                          readOnly: true
                          description: >-
                            Whether follow-up activity is associated with the
                            event's opportunity.
                        is_open:
                          title: Is open
                          type: string
                          readOnly: true
                          description: Whether the related opportunity remains open.
                        is_significant:
                          title: Is significant
                          type: boolean
                          readOnly: true
                          description: >-
                            Whether Peerlogic classified the event as
                            significant for follow-up or reporting.
                        modified_at:
                          title: Modified at
                          type: string
                          format: date-time
                          readOnly: true
                          description: Time when the event record was last updated.
                        significant_event_id:
                          title: Significant event id
                          type: string
                          readOnly: true
                          description: >-
                            Identifier of the significant event associated with
                            this record, when applicable.
                        opportunity:
                          title: Opportunity
                          type: string
                          readOnly: true
                          description: >-
                            Opportunity context associated with the event, when
                            one was identified.
                        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
                          description: Activity classification that produced the event.
                    description: Events in the current page.
              examples:
                missedCall:
                  summary: A significant missed-call event
                  value:
                    count: 1
                    next: null
                    previous: null
                    results:
                      - id: <EVENT_ID>
                        created_at: '2026-09-15T19:18:09Z'
                        modified_at: '2026-09-15T19:18:09Z'
                        trigger_type: missed_call
                        is_significant: true
                        is_followed_up: false
                        followed_up_at: null
                        is_open: true
                        significant_event_id: <EVENT_ID>
                        call:
                          id: <CALL_ID>
                          call_direction: inbound
                          call_connection: missed
                          call_start_time: '2026-09-15T19:17:31Z'
                          call_end_time: '2026-09-15T19:18:02Z'
                          caller_id: '+14805550123'
                          callee_id: '+14805550100'
                          went_to_voicemail: true
                          checked_voicemail: false
                          patients: []
                        opportunity: null
                        first_follow_up_call: null
        '400':
          description: The request parameters or body are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              example:
                practice_id: This parameter is required
        '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 subscriptions](/peerlogic-api-reference/subscriptions-and-events/list-subscriptions.md)
- [Receive webhook events](/guides/webhooks-and-subscriptions.md)
- [Get event](/peerlogic-api-reference/subscriptions-and-events/get-event.md)
- [List transcripts](/peerlogic-api-reference/transcripts/list-transcripts.md)
- [Get open and outstanding event counts](/peerlogic-api-reference/subscriptions-and-events/get-open-and-outstanding-event-counts.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.