---
title: "Api events"
method: GET
path: "/v1/api/events"
tags: ["Owner"]
---

# Api events

`GET /v1/api/events`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/api/events`
- Auth: HTTP bearer

## Query parameters

- `type` string, required

## Response `200`

OK

- ApiEventsResponse
  - `events` object[], required
    - `id` string, required
    - `type` 'call.summarized' | 'message.taken' | 'booking.created' | 'booking.cancelled' | 'ask.created' | 'ask.resolved' | 'follow_up.sent' | 'message.received' | 'lead.created' | 'needs_you.created', required
    - `apiVersion` string, required
    - `createdAt` string, date-time, required
    - `ledgerEntryId` string, nullable, required
    - `data` object, required
    - `lead` object, required
      - `job` string, nullable, required
      - `address` string, nullable, required
      - `urgency` 'urgent' | 'normal', required
      - `callbackNumber` string, nullable, required
      - `outcome` string, nullable, required
      - `band` 'hot' | 'warm' | 'cold', nullable, required
      - `score` integer, nullable, required
      - `fields` object, required

## Other responses

- `400`: Invalid request (body not JSON, or schema validation failed).
- `401`: Missing, expired or invalid bearer token.
- `429`: Too many requests from this caller; wait and try again.
- `500`: Unexpected server error (reported to Sentry).

---

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