---
title: "List engagement events"
method: GET
path: "/engagementEvents"
tags: ["engagementEvents"]
---

# List engagement events

`GET /engagementEvents`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/engagementEvents`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lumahealth/apis/rest-service/docs/engagementEvents/get.ts> (a function with typed inputs; its response is checked against the schema)

Engagement events are append-only and cannot be created directly through this endpoint; they are appended via the `pushEvent` operation on an engagement.

## Query parameters

- `engagement` string
- `user` string
- `deleted` 0 | 1
- `createdBy` string
- `updatedBy` string
- `createdAt` string, date-time
- `updatedAt` string, date-time
- `page` integer
- `limit` integer
- `_populate` string
- `_select` string

## Response `200`

List of engagement events

- object
  - `response` EngagementEventResponse[], required
    - `_id` string: Luma's internal ID of an object.
    - `user` string: The ID of the root account user.
    - `deleted` 0 | 1: Flag for logical deletion where 1 means deleted.
    - `createdBy` string: The ID of the user who created this object.
    - `updatedBy` string: The ID of the user who updated this object.
    - `createdAt` string, date-time: The date/time when this object was created.
    - `updatedAt` string, date-time: The date/time when this object was updated.
    - `engagement` string: ID of the parent Engagement this event occurred during.
    - `recipient` string: ID of the user this event is about, if applicable.
    - `payload` object: The event's contents.
      - `name` string: The kind of event, for example `AgentAssigned`, `MessageSent`, `VoiceCallStarted`, `EngagementCompleted`.
      - `body` object: Event-specific data, shape depends on `name`.
      - `metadata` object
        - `source` object
          - `service` string
          - `agent` string
          - `operation` string
        - `update` object[]
          - `fromEvent` string
          - `toEngagement` string
          - `op` '$set' | '$push' | '$pull' | '$addToSet'
  - `page` integer, required
  - `size` integer, required

## Other responses

- `401`: Not authenticated
- `403`: Access token does not have the required scope

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)