# Retrieves the details of all configured remote offices

Provides a list of remote offices along with configuration details such as proxy details, distribution server details, etc.

## Endpoint

`GET /api/1.4/som/remoteoffice`

## Request

### Request URL

`https://`[*{serverurl}*](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)`/api/1.4/som/remoteoffice`

### Scope

`DesktopCentralCloud.SOM.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Query Parameters

- **page** `string` *(Optional)*: Specifies the page number to retrieve. Default is 1
- **pagelimit** `string` *(Optional)*: Specifies the maximum number of items to return per page. The default value is 25. A maximum of 1000 records can be retrieved in a single request

### Sample Request

```curl
curl --request GET \
  --url https://appdomains/api/1.4/som/remoteoffice \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response

### Response Parameters

#### HTTP Code 200

Response Body: `application/json`

- `JSON Object`
  - **message_type** `string`: Name of the module
  - **message_response** `JSON Object`: Response message containing remote office details
  - **message_version** `string`: Version of the Api
  - **status** `string`: Status of the request

### Possible Response Codes

- **200** `HTTP code`: Request processed successfully

### Sample Response: HTTP 200

```json
{
  "message_type": "remoteoffice",
  "message_response": {
    "total": 3,
    "limit": 25,
    "page": 1,
    "remoteoffice": [
      {
        "updated_time": 1756445282837,
        "ds_status": 29,
        "is_https": true,
        "branch_office_name": "DS RemoteOffice",
        "agent_arc_loc": "",
        "compression_type": 1,
        "replicationpolicydetails.policy_name": "Policy_1",
        "branch_office_id": 301,
        "proxy_details_branch_office_id": 301,
        "resource_id_string": "309",
        "policytobranchofficerel.policy_id": 1,
        "agent_comm_branch_office_id": 301,
        "ds_dns_name": "ds.mycomp.com",
        "branch_office_desc": "--",
        "ds_version": "11.4.2522.01",
        "policytobranchofficerel.branch_office_id": 301,
        "proxy_port_number": 80,
        "last_contact_time": -1,
        "is_proxy": true,
        "colorquality_type": 16,
        "ds_https_port": "8384",
        "proxy_username": "Alex",
        "adgroupremoteofficemapping.branch_office_id": 301,
        "has_masteragent": true,
        "managed_computers": 1,
        "replicationpolicydetails.policy_id": 1,
        "error_code_kb_url": "--",
        "ds_sync_status": 1,
        "error_kb_url": "$(dcUrl)/agent_installation_logon_failure.html?",
        "ds_ipaddress": "10.92.8.98",
        "branch_office_customer_id": 1,
        "proxy_server_name": "Proxy - Server",
        "resource_id": 309,
        "disserverdetails.branch_office_id": 301,
        "error_code": 60006,
        "customer_name": "DC_CUSTOMER",
        "customer_id": 1,
        "resource_name": "Alex",
        "remarks": "[i18n]dc.som.agentinstall.remarks.unknown_credential[/i18n]"
      }
    ]
  },
  "message_version": "1.4",
  "status": "success"
}
```

## Rate Limit

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

**Duration:** 1 minute | **Threshold:** 120 | **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.