# Get Office Click-to-Run Settings

Retrieves Office Click-to-Run update configuration.

## Endpoint

`GET /dcapi/patch/settings/officeClickToRun`

## Request

### Request URL

`https://{server-hostname}:8383/dcapi/patch/settings/officeClickToRun`

### Scope

`PatchMgmt.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Sample Request

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

## Response

### Response Parameters

#### HTTP Code 200

Response Body — `application/json`

- JSON object
  - **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

### Possible Response Codes

- **200** — HTTP code

### Sample Response: HTTP 200

Office CTR configuration

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

## Rate Limit

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