---
title: "List the events of the account (new lead, handover requested, credit threshold, missed payment)"
method: GET
path: "/api/v1/events"
---

# List the events of the account (new lead, handover requested, credit threshold, missed payment)

`GET /api/v1/events`

## Request

- Base URL: `https://smartwebchat.eu`
- URL: `https://smartwebchat.eu/api/v1/events`
- Auth: HTTP bearer

Oldest first, paged with cursor. Events appear with a delay of 5 seconds. Events older than 30 days are not returned; if you poll less often, you lose events — use the webhooks for complete delivery. Events may be delivered more than once: quota.threshold may disappear and reappear with the same id if the warning mail failed (deduplicate by id). payment.failed: repeated notifications for the same payment transaction within 48 hours are delivered once; a later failure of the same transaction is a new event; without a transaction id it may be delivered more than once, with different ids. Catalog version 1.0; the schema of each type is listed under webhooks.

## Query parameters

- `type` string[]
- `cursor` string
- `limit` integer

## Response `200`

One page of events

- object
  - `data` EventPage
    - `events` object[], required
      - `id` string, required: Stable per event: <type>:<source id>.
      - `type` 'lead.created' | 'handover.requested' | 'quota.threshold' | 'payment.failed' | 'job.completed' | 'job.failed', required
      - `version` string, required
      - `occurredAt` string, date-time, required
      - `chatbotId` string, nullable, required
      - `data` union, required: Identifiers only, never contents. Read contents with the same key via the read path of the event type.
        - object
          - `leadId` string, required
        - object
          - `handoverRequestId` string, required
        - object
          - `thresholdPercent` integer, required
          - `period` string, required
        - object
        - object
          - `jobId` string, required
          - `jobType` 'knowledge_crawl' | 'knowledge_source', required
          - `status` 'succeeded' | 'partially_succeeded', required
          - `errorCode` unknown, required
        - object
          - `jobId` string, required
          - `jobType` 'knowledge_crawl' | 'knowledge_source', required
          - `status` 'failed', required
          - `errorCode` string, required
    - `nextCursor` string, nullable, required: Pass as cursor to get newer events; null means nothing newer yet.
    - `catalogVersion` '1.0', required
  - `error` unknown

## Other responses

- `400`: Unknown type, invalid cursor or limit out of range
- `401`: Missing or invalid API key
- `429`: Rate limit exceeded: 600 requests per minute per account across all /api/v1/ routes. Wait for the seconds given in Retry-After (60) and retry.
- `500`: The events could not be read; retry later

---

[API](https://skmtc.dev/smartwebchat/apis/smartwebchat-api.md) · [All operations](https://skmtc.dev/smartwebchat/apis/smartwebchat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/smartwebchat/apis/smartwebchat-api/revisions/1b052502dacb?raw)