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

# List Events



## OpenAPI

````yaml get /api/v2/event/list
openapi: 3.0.0
info:
  version: 6.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/event/list:
    get:
      tags:
        - Events
      summary: List Events
      operationId: listEvents
      parameters:
        - schema:
            type: string
            format: date-time
            description: Start of the time range (ISO 8601 datetime)
          required: true
          description: Start of the time range (ISO 8601 datetime)
          name: startDate
          in: query
        - schema:
            type: string
            format: date-time
            description: End of the time range (ISO 8601 datetime). Defaults to now.
          required: false
          description: End of the time range (ISO 8601 datetime). Defaults to now.
          name: endDate
          in: query
        - schema:
            type: integer
            nullable: true
            maximum: 100
            default: 20
            description: Maximum number of events to return (max 100)
          required: false
          description: Maximum number of events to return (max 100)
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            default: 0
            description: Number of events to skip for pagination
          required: false
          description: Number of events to skip for pagination
          name: offset
          in: query
        - schema:
            type: string
            description: >-
              Scope results to the events one Insight covers, resolved the same
              way that Insight's own run resolves them. Other filters narrow
              further within the Insight's events.
            example: rcfg_XVPcS3dLZFqzfQIfSeCpk
          required: false
          description: >-
            Scope results to the events one Insight covers, resolved the same
            way that Insight's own run resolves them. Other filters narrow
            further within the Insight's events.
          name: insightOId
          in: query
        - schema:
            type: array
            items:
              type: string
              enum:
                - EMAIL_SENT
                - EMAIL_REPLY_RECEIVED
                - CALL_TRANSCRIPT
                - DEAL_WON
                - DEAL_LOST
                - OPPORTUNITY_CREATED
                - MEETING_BOOKED
                - RESOURCE_INDEXED
                - RESOURCE_REINDEXED
                - PROJECT_UPDATE
                - TASK_COMPLETED
                - 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
            description: Filter by event types
          required: false
          description: Filter by event types
          name: eventTypes
          in: query
        - schema:
            type: array
            items:
              type: string
              enum:
                - EMAIL
                - CALL
                - CRM
                - RESOURCE
                - REVISION
                - SOCIAL
                - ADS
                - PRODUCT
                - UNKNOWN
            description: Filter by event categories
          required: false
          description: Filter by event categories
          name: eventCategories
          in: query
        - schema:
            type: array
            items:
              type: string
              enum:
                - DISCOVERY
                - DEMO
                - TECHNICAL_EVALUATION
                - WORKING_SESSION
                - NEGOTIATION_PRICING
                - ONBOARDING
                - CHECK_IN_SUCCESS
                - QBR_RENEWAL
                - EXPANSION_UPSELL
                - ESCALATION_CHURN_RISK
                - SUPPORT
                - INTERNAL_SYNC
                - OTHER
            description: >-
              Filter calls by classified purpose (single value, repeated param,
              or comma-separated)
          required: false
          description: >-
            Filter calls by classified purpose (single value, repeated param, or
            comma-separated)
          name: callPurposes
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these offering
              (product, service or solution) oIds (single value, repeated param,
              or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these offering
            (product, service or solution) oIds (single value, repeated param,
            or comma-separated)
          name: offerings
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these persona oIds
              (single value, repeated param, or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these persona oIds
            (single value, repeated param, or comma-separated)
          name: personas
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these segment oIds
              (single value, repeated param, or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these segment oIds
            (single value, repeated param, or comma-separated)
          name: segments
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these use case oIds
              (single value, repeated param, or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these use case oIds
            (single value, repeated param, or comma-separated)
          name: useCases
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these reference
              customer oIds (single value, repeated param, or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these reference
            customer oIds (single value, repeated param, or comma-separated)
          name: references
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these competitor oIds
              (single value, repeated param, or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these competitor oIds
            (single value, repeated param, or comma-separated)
          name: competitors
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these alternative
              oIds (single value, repeated param, or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these alternative oIds
            (single value, repeated param, or comma-separated)
          name: alternatives
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these buying trigger
              oIds (single value, repeated param, or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these buying trigger
            oIds (single value, repeated param, or comma-separated)
          name: buyingTriggers
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these core feature
              oIds (single value, repeated param, or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these core feature oIds
            (single value, repeated param, or comma-separated)
          name: coreFeatures
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these objection oIds
              (single value, repeated param, or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these objection oIds
            (single value, repeated param, or comma-separated)
          name: objections
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events with a finding matched to one of these proof point
              oIds (single value, repeated param, or comma-separated)
          required: false
          description: >-
            Only events with a finding matched to one of these proof point oIds
            (single value, repeated param, or comma-separated)
          name: proofPoints
          in: query
        - schema:
            type: boolean
            default: false
            description: >-
              When true, an event must match every entity oId given rather than
              any one per filter. Defaults to false.
          required: false
          description: >-
            When true, an event must match every entity oId given rather than
            any one per filter. Defaults to false.
          name: entityMatchAll
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Only events matching a library entity that carries one of these
              reporting tag oIds, from any tag group on any entity type (see
              tag-group/list). Multiple tags are OR'd.
          required: false
          description: >-
            Only events matching a library entity that carries one of these
            reporting tag oIds, from any tag group on any entity type (see
            tag-group/list). Multiple tags are OR'd.
          name: tags
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
            maxItems: 100
            description: >-
              Exclude events matching a library entity that carries one of these
              reporting tag oIds. Multiple tags are OR'd.
          required: false
          description: >-
            Exclude events matching a library entity that carries one of these
            reporting tag oIds. Multiple tags are OR'd.
          name: excludeTags
          in: query
      responses:
        '200':
          description: List of events for the workspace
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      events:
                        type: array
                        items:
                          type: object
                          properties:
                            oId:
                              type: string
                            eventType:
                              type: string
                              enum:
                                - EMAIL_SENT
                                - EMAIL_REPLY_RECEIVED
                                - CALL_TRANSCRIPT
                                - DEAL_WON
                                - DEAL_LOST
                                - OPPORTUNITY_CREATED
                                - MEETING_BOOKED
                                - RESOURCE_INDEXED
                                - RESOURCE_REINDEXED
                                - PROJECT_UPDATE
                                - TASK_COMPLETED
                                - 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
                            eventTimestamp:
                              type: string
                              nullable: true
                              format: date-time
                            processingStatus:
                              type: string
                            providerName:
                              type: string
                            eventSummary:
                              type: string
                            callPurpose:
                              type: string
                              enum:
                                - DISCOVERY
                                - DEMO
                                - TECHNICAL_EVALUATION
                                - WORKING_SESSION
                                - NEGOTIATION_PRICING
                                - ONBOARDING
                                - CHECK_IN_SUCCESS
                                - QBR_RENEWAL
                                - EXPANSION_UPSELL
                                - ESCALATION_CHURN_RISK
                                - SUPPORT
                                - INTERNAL_SYNC
                                - OTHER
                              description: >-
                                Classified purpose of the call (CALL_TRANSCRIPT
                                only)
                          required:
                            - oId
                            - eventType
                            - eventTimestamp
                      total:
                        type: integer
                      hasMore:
                        type: boolean
                    required:
                      - events
                      - total
                      - hasMore
                required:
                  - data
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````

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