---
title: "Get engagements with list of custom events from rules"
method: GET
path: "/v1/engagement/extended"
tags: ["Engagement"]
---

# Get engagements with list of custom events from rules

`GET /v1/engagement/extended`

## Request

- Base URL: `https://app.aptrinsic.com`
- URL: `https://app.aptrinsic.com/v1/engagement/extended`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/engagement/extended/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves engagements with list of custom events that are used in the audience rule, either directly or indirectly via a feature match. Supports paging.
Examples: 

| URI   | Results  |
| ----- | -------- |
| GET /v1/engagement/extended?pageSize=100 | Get first 100 engagements. |
| GET /v1/engagement/extended?pageSize=100&pageNumber=1 | Get next 100 engagements. |
| GET /v1/engagement/extended?contentTypes=IN_APP_DIALOG,IN_APP_GUIDE | Get dialog and guide engagements. |

## Query parameters

- `contentTypes` string[]
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Success

- EngagementsWithCustomEventsPage
  - `engagements` EngagementWithCustomEvents[]: Array of engagements
    - `id` string, required
    - `name` string, required
    - `description` string
    - `type` 'EMAIL' | 'IN_APP_DIALOG' | 'IN_APP_CAROUSEL' | 'IN_APP_GUIDE' | 'IN_APP_NOTIFICATION' | 'OUT_BOUND_EMAIL' | 'IN_APP_NPS_SURVEY' | 'IN_APP_CES_SURVEY' | 'IN_APP_RATING_SURVEY' | 'IN_APP_BOOLEAN_SURVEY' | 'IN_APP_MULTIPLE_QUESTION_SURVEY', required
    - `state` 'IN_PROGRESS' | 'STARTED' | 'PAUSED' | 'FAILED' | 'EDITING' | 'COMPLETED', required
    - `propertyKeys` string[], required: Aptrinsic Tag Key, at least one is required
    - `envs` string[], required: A list of environments
    - `customEvents` CustomEventMetadata[], required: A list of custom events that are referenced in the audience rules, also includes events indirectly referenced via a feature mapped to a custom event.
      - `name` string, required: Name of custom event
      - `properties` string[]
  - `pageNumber` integer: Page number
  - `isLastPage` boolean: True if no more records available on next page

## Other responses

- `400`: Bad request
- `401`: Unauthorized or bad API Key
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api.md) - [All operations](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/revisions/e7b197b373d8?raw)