---
title: "Get engagement"
method: GET
path: "/v1/engagement/{engagementId}"
tags: ["Engagement"]
---

# Get engagement

`GET /v1/engagement/{engagementId}`

## Request

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

Retrieves the engagement with the given id

## Path parameters

- `engagementId` string, required

## Response `200`

Success

- Engagement: Engagement object
  - `defaultLanguage` string
  - `id` string, required
  - `languages` LocalizationStatus[]
    - `languageCode` string
    - `translated` boolean
  - `translationState` string
  - `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

## Other responses

- `400`: Bad request
- `401`: Unauthorized or bad API Key
- `404`: Account not found
- `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)