> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kapso.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List project events

> Returns project-scoped events for the project associated with your API key,
newest first. Use filters to narrow by event name, linked WhatsApp
conversation, or occurrence time.

Use `limit`, `after`, and `before` for cursor pagination. Cursor-paginated
responses include `paging`; legacy offset responses include `meta`.




## OpenAPI

````yaml /api/platform/v1/openapi-platform.yaml get /events
openapi: 3.1.0
info:
  title: Kapso Platform API
  version: 0.2.0
  description: >
    Build WhatsApp messaging into your product. Manage customers, connect phone
    numbers, send broadcasts, and handle conversations.
servers:
  - url: https://api.kapso.ai/platform/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Customers
    description: Manage customer accounts
  - name: Setup Links
    description: WhatsApp onboarding via embedded signup
  - name: Phone Numbers
    description: Connect and manage WhatsApp numbers
  - name: Webhooks
    description: Subscribe to WhatsApp events
  - name: Display Names
    description: Update WhatsApp business display names
  - name: Broadcasts
    description: |
      Send template messages at scale

      **Alpha**: This API is in alpha and subject to change
  - name: Conversations
    description: Manage conversation state
  - name: Media
    description: Upload media files for WhatsApp messaging
  - name: Users
    description: Manage project team members
  - name: Inbox Embeds
    description: Create and manage embeddable inbox access links
  - name: Webhook Deliveries
    description: View webhook delivery attempts and their status
  - name: External API Logs
    description: View logs of external API calls made by the project
  - name: Log Search
    description: Search log events across API, Meta, workflow, and webhook sources
  - name: Events
    description: Emit and query project-scoped events
  - name: Provider Models
    description: List available AI provider models
  - name: WhatsApp Flows
    description: Build interactive WhatsApp Flows for surveys and forms
  - name: Contacts
    description: Manage WhatsApp contacts
paths:
  /events:
    get:
      tags:
        - Events
      summary: List project events
      description: >
        Returns project-scoped events for the project associated with your API
        key,

        newest first. Use filters to narrow by event name, linked WhatsApp

        conversation, or occurrence time.


        Use `limit`, `after`, and `before` for cursor pagination.
        Cursor-paginated

        responses include `paging`; legacy offset responses include `meta`.
      operationId: listProjectEvents
      parameters:
        - name: name
          in: query
          description: Filter by event name.
          schema:
            type: string
          example: conversation.csat_scored
        - name: conversation_id
          in: query
          description: Filter by linked WhatsApp conversation ID.
          schema:
            type: string
            format: uuid
        - name: occurred_after
          in: query
          description: Only return events at or after this timestamp.
          schema:
            type: string
            format: date-time
        - name: occurred_before
          in: query
          description: Only return events at or before this timestamp.
          schema:
            type: string
            format: date-time
        - name: limit
          in: query
          description: >-
            Maximum number of results per cursor-paginated page (default 20, max
            100).
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: before
          in: query
          description: Cursor for the previous page (Base64 encoded).
          schema:
            type: string
        - name: after
          in: query
          description: Cursor for the next page (Base64 encoded).
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectEventListResponse'
              examples:
                events:
                  summary: Project events found
                  value:
                    data:
                      - id: 990e8400-e29b-41d4-a716-446655440004
                        name: conversation.csat_scored
                        occurred_at: '2026-06-27T14:30:00Z'
                        conversation_id: 770e8400-e29b-41d4-a716-446655440002
                        properties:
                          score: 4
                          reason: Issue resolved in one reply
                    paging:
                      cursors:
                        before: null
                        after: null
                      next: null
                      previous: null
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    ProjectEventListResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProjectEvent'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
        paging:
          $ref: '#/components/schemas/Paging'
    ProjectEvent:
      type: object
      required:
        - id
        - name
        - occurred_at
        - conversation_id
        - properties
      properties:
        id:
          type: string
          format: uuid
          description: Unique event ID
        name:
          type: string
          description: >-
            Event name. Lowercase dotted snake_case is recommended for
            consistency.
          example: conversation.csat_scored
        occurred_at:
          type: string
          format: date-time
          description: When the event occurred
        conversation_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Linked WhatsApp conversation ID, when provided
        properties:
          type: object
          additionalProperties:
            oneOf:
              - type: string
              - type: number
              - type: boolean
              - type: 'null'
          description: Flat event properties object
    PaginationMeta:
      type: object
      required:
        - page
        - per_page
        - total_pages
        - total_count
      properties:
        page:
          type: integer
          minimum: 1
        per_page:
          type: integer
          minimum: 1
        total_pages:
          type: integer
          minimum: 0
        total_count:
          type: integer
          minimum: 0
    Paging:
      type: object
      properties:
        cursors:
          $ref: '#/components/schemas/PaginationCursor'
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    PaginationCursor:
      type: object
      properties:
        before:
          type: string
          description: Cursor for previous page (Base64 encoded)
        after:
          type: string
          description: Cursor for next page (Base64 encoded)
  responses:
    UnauthorizedError:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: Request validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````