Skip to main content
GET
/
api
/
v2
/
event
/
list
List Events
curl --request GET \
  --url https://app.octavehq.com/api/v2/event/list \
  --header 'api_key: <api-key>'
import requests

url = "https://app.octavehq.com/api/v2/event/list"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.octavehq.com/api/v2/event/list', 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://app.octavehq.com/api/v2/event/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$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://app.octavehq.com/api/v2/event/list"

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

	req.Header.Add("api_key", "<api-key>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/event/list")
  .header("api_key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/event/list")

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

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "events": [
      {
        "oId": "<string>",
        "eventTimestamp": "<string>",
        "processingStatus": "<string>",
        "providerName": "<string>",
        "eventSummary": "<string>"
      }
    ],
    "total": 123,
    "hasMore": true
  }
}

Authorizations

api_key
string
header
required

Query Parameters

startDate
string<date-time>
required

Start of the time range (ISO 8601 datetime)

endDate
string<date-time>

End of the time range (ISO 8601 datetime). Defaults to now.

limit
integer | null
default:20

Maximum number of events to return (max 100)

Required range: x <= 100
offset
integer | null
default:0

Number of events to skip for pagination

eventTypes
enum<string>[]

Filter by event types

Available options:
EMAIL_SENT,
EMAIL_REPLY_RECEIVED,
CALL_TRANSCRIPT,
DEAL_WON,
DEAL_LOST,
OPPORTUNITY_CREATED,
MEETING_BOOKED,
RESOURCE_INDEXED,
RESOURCE_REINDEXED,
ENTITY_CREATED,
ENTITY_UPDATED,
SOCIAL_MESSAGE_SENT,
SOCIAL_MESSAGE_RECEIVED,
SOCIAL_CONNECTION_SENT,
SOCIAL_CONNECTION_ACCEPTED,
AD_SET_PUBLISHED,
AD_PERFORMANCE_SNAPSHOT,
BULK_IMPORT_SUMMARY,
PROCESSING_NOT_APPLICABLE,
PROVIDER_EVENT_TYPE_UNKNOWN,
UNKNOWN
eventCategories
enum<string>[]

Filter by event categories

Available options:
EMAIL,
CALL,
CRM,
RESOURCE,
REVISION,
SOCIAL,
ADS,
UNKNOWN

Response

200 - application/json

List of events for the workspace

data
object
required