Get engagement

GET /v1/engagement/{engagementId}

Retrieves the engagement with the given id

Path parameters

engagementId string Required

Engagement id

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- defaultLanguage string
- id string Required
- languages array[object]
  
  Hide languages attributes Show languages attributes object
  
  languageCode string
  
  translated boolean
- translationState string
- name string Required
- description string
- type string Required
  
  Values are 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, or IN_APP_MULTIPLE_QUESTION_SURVEY.
- state string Required
  
  Values are IN_PROGRESS, STARTED, PAUSED, FAILED, EDITING, or COMPLETED.
- propertyKeys array[string] Required
  
  Aptrinsic Tag Key, at least one is required
- envs array[string] Required
  
  A list of environments
400

Bad request
401

Unauthorized or bad API Key
404

Account not found
429

Rate limit exceeded

GET /v1/engagement/{engagementId}

curl \
 --request GET 'https://api.aptrinsic.com/v1/engagement/{engagementId}'

Response examples (200)

{
  "defaultLanguage": "string",
  "id": "string",
  "languages": [
    {
      "languageCode": "string",
      "translated": true
    }
  ],
  "translationState": "string",
  "name": "string",
  "description": "string",
  "type": "EMAIL",
  "state": "IN_PROGRESS",
  "propertyKeys": [
    "AP-XXXXXXXXXX-2"
  ],
  "envs": [
    "Production"
  ]
}