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

# List events

> The company's event timeline in chronological order. Poll incrementally with `since=` (an ISO-8601 timestamp), optionally filter by `eventType`, and cap the page with `limit` (1–500, default 100). This is the pull equivalent of webhooks.



## OpenAPI

````yaml https://api.kuahr.com/openapi/v1.json get /v1/events
openapi: 3.1.1
info:
  title: Kua API
  description: >-
    The Kua developer API — payroll, wallets, and payments for your own company.


    Authenticate with an API key issued from **Settings → API keys** in the
    dashboard, sent in the `X-Api-Key` header. Every request is scoped to the
    company that owns the key. Base URL: `https://api.kuahr.com` (all endpoints
    are versioned under `/v1`).
  version: v1
servers:
  - url: https://api.kuahr.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Payroll
    description: List and create payroll runs.
  - name: Employees
    description: Add people to your company.
  - name: Events
    description: The company event timeline (also delivered via webhooks).
  - name: Webhooks
    description: Register endpoints and inspect deliveries.
  - name: Test data
    description: Manage sandbox (test-mode) data.
  - name: Leave
    description: >-
      Time-off types, requests, balances, and allocations (requires the Leave
      add-on).
  - name: Advances
    description: Salary advances (requires the Salary advance add-on).
  - name: Performance
    description: OKRs, appraisals, and promotions (requires the Performance add-on).
paths:
  /v1/events:
    get:
      tags:
        - Events
      summary: List events
      description: >-
        The company's event timeline in chronological order. Poll incrementally
        with `since=` (an ISO-8601 timestamp), optionally filter by `eventType`,
        and cap the page with `limit` (1–500, default 100). This is the pull
        equivalent of webhooks.
      parameters:
        - name: since
          in: query
          schema:
            type: string
            format: date-time
        - name: eventType
          in: query
          schema:
            type: string
        - name: limit
          in: query
          schema:
            pattern: ^-?(?:0|[1-9]\d*)$
            type:
              - integer
              - string
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EventItem'
              example:
                - id: 0c2f4e6a-0000-0000-0000-000000000001
                  occurredAt: '2026-07-25T10:30:00+00:00'
                  eventType: payroll.run.disbursed
                  aggregateType: PayrollRun
                  aggregateId: 8ab1c2d3-0000-0000-0000-000000000001
                  payload: >-
                    {"runId":"8ab1c2d3-0000-0000-0000-000000000001","settled":42,"status":"Disbursed"}
        '401':
          description: Unauthorized
components:
  schemas:
    EventItem:
      required:
        - id
        - occurredAt
        - eventType
        - aggregateType
        - aggregateId
        - payload
      type: object
      properties:
        id:
          type: string
          description: The event's unique id. Dedupe on this.
          format: uuid
        occurredAt:
          type: string
          description: When the event occurred (ISO-8601, UTC).
          format: date-time
        eventType:
          type: string
          description: The event type, e.g. `payroll.run.disbursed`.
        aggregateType:
          type: string
          description: The kind of entity the event is about, e.g. `PayrollRun`.
        aggregateId:
          type: string
          description: The id of the entity the event is about.
          format: uuid
        payload:
          type: string
          description: Event-specific fields, as a JSON-encoded string.
      description: One entry on the company's event timeline.
  securitySchemes:
    ApiKey:
      type: apiKey
      description: Your API key, e.g. `kua_live_…` (or `kua_test_…` in test mode).
      name: X-Api-Key
      in: header

````