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

## Endpoints

**GET** `/api/1.4/som/remoteoffice`

## Request URL

```
https://{serverurl}/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

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

### Java

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/1.4/som/remoteoffice"))
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}
```

### Python

```python
import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = { 'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/api/1.4/som/remoteoffice", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

### Deluge

```javascript
headersMap = Map();
headersMap.put("Accept", "application/json");

response = invokeUrl
[
    url: "https://appDomain/api/1.4/som/remoteoffice"
    type: GET
    headers: headersMap
    connection: connection_name
]

info response;
```

### PowerShell

```powershell
$headers=@{}
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/1.4/som/remoteoffice' -Method GET -Headers $headers
```

## Response Parameters

### HTTP 200

**Response Body**: `application/json`

- **message_type** (string)  
  Name of the module

- **message_response** (JSON object)  
  Response message containing remote office details

  - **total** (integer)  
    Total number of remote offices

  - **limit** (integer)  
    Number of remote offices per page

  - **page** (integer)  
    Current page number

  - **remoteoffice** (JSON array)

    - **updated_time** (integer)  
      Represents the most recent time the remote office details were modified

    - **is_https** (boolean)  
      Indicates whether secure HTTPS communication is enabled for the remote office

    - **ds_status** (integer)  
      Specifies the Distribution Server installation state in the remote office. Possible values:  
      - 21 - Yet to install  
      - 22 - Installed  
      - 23 - Uninstalled  
      - 29 - Installation Failure  

    - **branch_office_name** (string)  
      Specifies the display name of the remote office

    - **agent_arc_loc** (string)  
      Specifies the location where the Remote Office agent installation files were stored. This field is currently deprecated and no longer in use

    - **compression_type** (integer)  
      Defines the compression type used during data transfer from the remote office. Possible values:  
      - 1 - Best  
      - 0 - Fast  

    - **replicationpolicydetails.policy_name** (string)  
      Indicates the policy's name applied for replicating data between the remote office and the server

    - **branch_office_id** (integer)  
      A unique identifier for the remote office

    - **proxy_details_branch_office_id** (integer)  
      Unique identifier linking the remote office to its proxy server details

    - **resource_id_string** (string)  
      String representation of the unique identifier for the remote office

    - **policytobranchofficerel.policy_id** (integer)  
      Unique identifier of the policy associated with this remote office

    - **agent_comm_branch_office_id** (integer)  
      Unique identifier for the remote office associated with the agent communication settings

    - **ds_dns_name** (string)  
      DNS name of the Distribution Server connected to the remote office

    - **branch_office_desc** (string)  
      Text description giving additional information about the remote office

    - **ds_version** (string)  
      Indicates the Distribution Server version associated with the remote office

    - **policytobranchofficerel.branch_office_id** (integer)  
      Unique identifier linking the remote office to branch office policy configurations

    - **proxy_port_number** (integer)  
      Port number of the proxy server associated with the remote office

    - **last_contact_time** (integer)  
      Last contact time of the remote office with the server

    - **is_proxy** (boolean)  
      Indicates whether a proxy server is configured for the remote office

    - **colorquality_type** (integer)  
      Defines the color quality type associated with the branch office. Possible values:  
      - 24 - True color  
      - 16 - High  
      - 8 - Medium  
      - 4 - Low  

    - **ds_https_port** (string)  
      Port number used for HTTPS communication with the Distribution Server

    - **proxy_username** (string)  
      Username for the proxy server associated with the remote office

    - **adgroupremoteofficemapping.branch_office_id** (integer)  
      Unique identifier for the remote office mapping associated with the Active Directory group

    - **has_masteragent** (boolean)  
      Indicates whether the remote office is associated with the distribution server

    - **managed_computers** (integer)  
      Number of computers managed by the remote office

    - **replicationpolicydetails.policy_id** (integer)  
      Unique identifier for the replication policy associated with the remote office

    - **error_code_kb_url** (string)  
      URL for the knowledge base article related to the error code

    - **ds_sync_status** (integer)  
      Indicates the synchronization status of data such as patches, configurations, and deployment details from the server to the Distribution Server. Possible values:  
      - 101 - Sync started  
      - 102 - Sync inprogress  
      - 104 - Sync failure  

    - **error_kb_url** (string)  
      URL for the knowledge base article related to the error

    - **ds_ipaddress** (string)  
      Indicates the IP address of the distribution server for the remote office

    - **branch_office_customer_id** (integer)  
      Unique identifier for the customer associated with the remote office

    - **proxy_server_name** (string)  
      Name of the proxy server associated with the remote office

    - **resource_id** (integer)  
      Unique identifier for the remote office

    - **disserverdetails.branch_office_id** (integer)  
      Unique identifier for the remote office associated with distribution server details

    - **error_code** (integer)  
      Error code indicating the status of the remote office

    - **customer_name** (string)  
      Name of the customer associated with the remote office

    - **customer_id** (integer)  
      Unique identifier for the customer associated with the remote office

    - **resource_name** (string)  
      Name of the distribution server associated with the remote office

    - **remarks** (string)  
      Remarks or comments related to the remote office

- **message_version** (string)  
  Version of the API

- **status** (string)  
  Status of the request

## 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"
}
```

## Possible HTTP Status Codes

- **200**  
  Request processed successfully

## Rate Limit

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