Events

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.

GET

api

events

List events

curl --request GET \
  --url https://api.prod.peerlogic.com/api/events/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.peerlogic.com/api/events/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.peerlogic.com/api/events/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.peerlogic.com/api/events/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.peerlogic.com/api/events/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

{
  "practice_id": "This parameter is required"
}

{
  "detail": "'Authorization' header is required"
}

Authorizations

Authorization

string

header

required

Bearer access token issued by Peerlogic.

Query Parameters

string

Return a specific event ID.

call_id

string

Return events associated with a specific call ID.

call__practice_id

string

Legacy practice filter. Use practice_id for new integrations.

call__call_direction

enum<string>

Return events for inbound, outbound, or internal calls.

Available options:

inbound,

outbound,

internal

call__call_connection

enum<string>

Return events for missed or connected calls.

Available options:

missed,

connected

call__went_to_voicemail

boolean

Set to true or false to filter by whether the call reached voicemail.

call__checked_voicemail

boolean

Set to true or false to filter by whether the voicemail was checked.

trigger_type

enum<string>

Return events produced by this trigger type.

Available options:

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

is_significant

boolean

Set to true or false to filter by whether Peerlogic marked the event as significant.

call__call_start_time

string

Limit results by call start time using the supported date or date-time range syntax.

is_followed_up

boolean

Set to true or false to filter by whether the related opportunity has been followed up.

is_open

boolean

Set to true or false to filter by whether the related opportunity remains open.

status

enum<string>

Filter by the outcome status of the related opportunity.

Available options:

success,

failure,

omitted

practice_id

string

required

Required. Return events for this practice ID.

name_any

string

Search caller, callee, contact, and patient names associated with the event.

sort

string

Order results by a supported event field. Prefix a field with - for descending order.

page

integer

Page number to return.

page_size

integer

Maximum number of events to return on one page.

Response

Successful response for list events.

count

integer

required

Total number of matching events.

results

object[]

required

Events in the current page.

Show child attributes

string<uri> | null

URL for the next page, or null when this is the final page.

string<uri> | null

URL for the previous page, or null when this is the first page.

List events

curl --request GET \
  --url https://api.prod.peerlogic.com/api/events/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.peerlogic.com/api/events/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.peerlogic.com/api/events/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.peerlogic.com/api/events/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.peerlogic.com/api/events/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

{
  "practice_id": "This parameter is required"
}

{
  "detail": "'Authorization' header is required"
}

Peerlogic API

VoIP Platform API (Preview)

List events

Authorizations

Query Parameters

Response