# Get Office Click-to-Run Settings

Retrieves Office Click-to-Run update configuration.

## Endpoint

`GET /dcapi/patch/settings/officeClickToRun`

## Request URL

`https://{serverurl}/dcapi/patch/settings/officeClickToRun`

Server URL: [serverurl](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)

## Scope

`DesktopCentralCloud.PatchMgmt.READ`

## Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Query Parameters

| Parameter | Type | Required |
|---|---|---|
| customerid | long | Optional |

### Sample Request

```curl
curl --request GET \
  --url https://appdomains/dcapi/patch/settings/officeClickToRun \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

Response body: `application/json`

| Parameter | Type | Description |
|---|---|---|
| officeCTREnabled | boolean | Whether Office Click-to-Run updates are enabled |
| updateChannel | string | Update channel: Monthly, Semi-Annual, etc. |
| targetVersion | string | Target Office version string |
| excludeApps | array | List of excluded Office applications |
| customerSettings | JSON Object | Customer-specific settings object |

### Sample Response: HTTP 200

Office CTR configuration

```json
{
  "excludeApps": [],
  "officeCTREnabled": true,
  "customerSettings": {},
  "updateChannel": "Monthly",
  "targetVersion": "16.0.12345"
}
```

## Rate Limits

![](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.