# Fetch engage definitions for one or more engage IDs

Get list of available engages

## Endpoints

`GET /intelligence/sensors/api/getEngages`

## Request URL

https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/intelligence/sensors/api/getEngages

## Scope

`DesktopCentralCloud.Platform.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** `string` — **Mandatory**
  - `application/engages.v1+json`

### Query Parameters

- **engageIDs** `string` — Optional
  - Optional comma-separated engage IDs (e.g., 1001,1002). Omit to retrieve all engages

## Sample Request

```curl
curl --request GET \
  --url https://appdomains/intelligence/sensors/api/getEngages \
  --header 'Accept: application/engages.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

#### Response Body — application/json

`JSON Object`

- **name** `string`
  - Name of the engage
- **label** `string`
  - Display label
- **description** `string`
  - Description of what the engage does
- **questions** `JSON Array`
  - List of questions shown to the user
- **senderInfo** `JSON Object`
  - Sender details shown to the recipient
- **endMessage** `string`
  - Message shown after the user completes the engage
- **timeout** `string`
  - Time limit in minutes for the user to respond

### HTTP Code 500

#### Response Body — application/json

`JSON Object`

- **errorCode** `string`
  - Error code for the server error
- **errorMessage** `string`
  - Details about the error

## Possible Response Codes

- **200** `HTTP code`
- **500** `HTTP code`

## Sample Response: HTTP 200

Single engage definition with questions and sender info

```json
{
  "1001": {
    "senderInfo": {
      "role": "Administrator",
      "name": "IT Ops"
    },
    "endMessage": "Thank you",
    "name": "Patch Feedback",
    "questions": [
      {
        "questionID": "9001",
        "question": "Can we reboot now?",
        "options": {
          "501": "Yes",
          "502": "Later"
        },
        "defaultOption": "Later",
        "type": 2
      }
    ],
    "description": "Collect user confirmation",
    "label": "Patch Prompt",
    "timeout": 30
  }
}
```

## Sample Response: HTTP 500

Server error while loading engages

```json
{
  "errorMessage": "An internal error occurred while fetching engage details.",
  "errorCode": "INTERNAL_ERROR_WITH_CUSTOM_MSG"
}
```

![ ](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**Duration:** 1 minute | **Threshold:** 30 | **Lock period:** 5 minutes

Duration - Time window for the threshold.  
Threshold - Number of API calls allowed within the specified duration.  
Lock Period - Wait time before consecutive API requests.