# Retrieve details of a specific remote office

Retrieves details of a specific remote office (branch office) by ID including DS details, proxy configuration, replication policy, and auto-install settings.

## Endpoint

`GET /dcapi/som/remote-offices/{remote_office_id}`

## Request

### Request URL

`https://{server-hostname}:8383/dcapi/som/remote-offices/{remote_office_id}`

### Scope

`SOM.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** — `string` (Mandatory): `application/remoteOfficeDetails.v1+json`

#### Path Parameters

- **remote_office_id** — `string` (Mandatory): Unique identifier for the remote office. Get the remote office ID from the `resource_id` field in the [Get Remote Offices](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remote-offices-getremoteoffices.html) response.

## Sample Request

```curl
curl --request GET \
  --url https://appdomain/dcapi/som/remote-offices/{remote_office_id} \
  --header 'Accept: application/remoteOfficeDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

#### Response Body — `application/json`

`JSON Object`

- **remoteOfficeID** — `string`: Unique identifier of the remote office.
- **remoteOfficeName** — `string`: Display name of the remote office as configured by the administrator.
- **description** — `string`: Administrator-provided description of the remote office. Returns `'--'` if not set.
- **communicationType** — `string`: Communication type between agents and the server: `'DS'` (via Distribution Server) or `'Direct'` (direct to server).
- **agentCommunication** — `string`: Protocol used for agent communication: HTTPS.
- **managedComputerCount** — `integer`: Total number of computers currently managed under this remote office.
- **isProxyDefined** — `boolean`: Whether a proxy server is configured for this remote office.
- **proxyDetails** — `JSON Object`: Proxy server configuration for agent communication. Present only when `isProxyDefined` is true.
- **hasDS** — `boolean`: Whether a Distribution Server is associated with this remote office.
- **dsDetails** — `JSON Object`: Distribution Server configuration and status details. Present only when `hasDS` is true.
- **hasOSDeployment** — `boolean`: Whether OS Deployment is enabled for this remote office.
- **osdSettings** — `JSON Object`: OS Deployment configuration including replication policy and ADK install settings. Present only when `hasOSDeployment` is true.
- **remoteInstallationDetails** — `JSON Object`: Auto-installation configuration including agent and DS auto-install toggles and the credential used for installation.
- **replicationPolicy** — `JSON Object`: Summary of the replication policy assigned to this remote office for data synchronization.
- **remoteControlSettings** — `JSON Object`: Remote control session settings including compression and display color depth configuration.

### HTTP Code 404

#### Response Body — `application/json`

`JSON Object`

- **statusCode** — `string`: HTTP status code (`404`).
- **errorCode** — `string`: Error code identifying the resource that was not found.
- **message** — `string`: Error message describing the missing resource.

### Possible Response Codes

- **200** — HTTP code
- **404** — HTTP code

## Sample Responses

### HTTP 200

Remote office with Distribution Server

```json
{
  "dsDetails": {
    "dsHTTPSPort": "8384",
    "updatedTime": "Apr 13, 2026 04:47 PM",
    "dsName": "DSserver1",
    "dsID": "3039",
    "dsStatus": "DS Installation Failed",
    "dsVersion": "11.5.2611.03",
    "dsHTTPPort": "8021",
    "dsLastContactTime": "--",
    "dsIPAddress": [
      "10.92.63.36"
    ],
    "dsInstallationStatus": 29,
    "domainNetbiosName": "ECSOM",
    "dsDNSName": "ds.mycomp.com"
  },
  "description": "--",
  "communicationType": "DS",
  "replicationPolicy": {
    "policyName": "Business Hours Only",
    "replicationInterval": 30,
    "replicationPolicyID": "902"
  },
  "agentCommunication": "HTTPS",
  "remoteControlSettings": {
    "compression": 1,
    "colorQuality": 16
  },
  "hasDS": true,
  "hasOSDeployment": false,
  "remoteOfficeID": "906",
  "remoteOfficeName": "US DS",
  "remoteInstallationDetails": {
    "credentialDetails": {
      "credentialUUID": null,
      "credentialID": "3",
      "credentialName": "ECSOM",
      "domainNetbiosName": ""
    },
    "isDSAutoInstall": true,
    "isAgentAutoInstall": true
  },
  "isProxyDefined": false,
  "managedComputerCount": 0
}
```

### HTTP 404

Remote office not found

```json
{
  "errorCode": "30028",
  "message": "Remote office does not exist",
  "statusCode": 404
}
```

## Rate Limit

**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.