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>'
{
  "data": {
    "events": [
      {
        "oId": "<string>",
        "eventTimestamp": "<string>",
        "processingStatus": "<string>",
        "providerName": "<string>",
        "eventSummary": "<string>"
      }
    ],
    "total": 123,
    "hasMore": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

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