# Retrieve all domains in scope

Retrieves all domains (Active Directory and workgroup) in scope. Supports filtering by managed computers, AD type, managed users, and network type.

## Endpoints

`GET /dcapi/som/domains`

## Request URL

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

## Scope

`DesktopCentralCloud.SOM.READ`

## Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** `string` **Mandatory**
  - `application/domainsDetails.v1+json`

### Query Parameters

- **page** `integer` Optional
  - Specifies the page number to retrieve. Default is 1
- **size** `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
- **fields** `string` Optional
  - Comma-separated list of fields to include in the response for projection
- **hasComputers** `boolean` Optional
  - If set to true, returns only domains that have managed computers
- **hasManagedUsers** `boolean` Optional
  - If set to true, returns only domains that have managed users
- **onlyAD** `boolean` Optional
  - If set to true, returns only Active Directory domains
- **onlyDirectAD** `boolean` Optional
  - If set to true, returns only directly joined Active Directory domains
- **networkType[]** `string` Optional
  - Filters domains by network type. Accepts multiple values. Supported values: 1 (Workgroup), 2 (Active Directory), 3 (Entra AD)
- **searchValue** `string` Optional
  - Search value used to filter domains based on its name

## Sample Request

```curl
curl --request GET \
  --url https://appdomains/dcapi/som/domains \
  --header 'Accept: application/domainsDetails.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

#### Response Body: `application/json`

- `JSON Object`
  - **resourceID** `string`
    - Unique resource identifier of the domain in the system
  - **name** `string`
    - Short display name of the domain (typically the NetBIOS name)
  - **domainName** `string`
    - NetBIOS name of the domain used for authentication and network identification
  - **adDomainName** `string`
    - Fully qualified domain name (FQDN) of the Active Directory domain (e.g., 'corp.example.com')
  - **isADDomain** `boolean`
    - true if this is an Active Directory domain, false if it is a workgroup
  - **guid** `string`
    - Globally unique identifier (GUID) of the domain object in Active Directory
  - **hasCredentials** `boolean`
    - Whether authentication credentials are configured for this domain
  - **credentialID** `string`
    - Identifier of the credential associated with this domain. Fetch details from [List Credentials](https://www.manageengine.com/products/desktop-central/help/api/cloud/credentials-list-credentials.html)
  - **credentialUUID** `string`
    - Universally unique identifier (UUID) of the credential associated with this domain
  - **username** `string`
    - Username configured for domain access and AD operations
  - **hasManagedComputers** `boolean`
    - Whether there are any managed computers discovered under this domain
  - **useSSL** `boolean`
    - Whether SSL/TLS is used for LDAP communication with the domain controller
  - **portNumber** `string`
    - Port number used for LDAP communication (0 indicates default port)
  - **dcName** `string`
    - Hostname of the domain controller used for AD sync operations
  - **dnsSuffix** `string`
    - DNS suffix of the domain, typically matching the AD FQDN
  - **syncType** `string`
    - Type of domain synchronization: 1 = Direction Connection, 2- Through AD Connector
  - **syncDetails** `JSON Object`
    - Scheduled synchronization configuration including time, frequency, and timezone
  - **dmDomainID** `string`
    - Internal Domain Manager identifier for this domain
  - **networkType** `string`
    - Network type classification: 1- Workgroup, 2- Active Directory, 3 - Entra AD
  - **adConnectorID** `string`
    - Identifier of the AD Connector used for syncing this domain. null when no connector is configured
  - **oauthMetaID** `string`
    - OAuth metadata identifier for Azure AD integration. null when OAuth is not configured
  - **oauthType** `string`
    - Type of OAuth authentication configured (e.g., Azure AD). null when OAuth is not configured

### Possible Response Codes

- **200** `HTTP code`
- **204** `HTTP code`

## Sample Response: HTTP 200

Active Directory domain

```json
[
  {
    "resourceID": "311",
    "adDomainName": "ECSOM.CBE.COM",
    "adConnectorID": null,
    "syncDetails": {
      "syncTime": "06:00",
      "remainingSyncCount": 3,
      "timeZone": "Asia/Calcutta",
      "frequency": 24
    },
    "oauthMetaID": null,
    "hasManagedComputers": false,
    "hasCredentials": true,
    "portNumber": 0,
    "useSSL": false,
    "credentialUUID": "5be0e976-d613-46a0-bdc9-5a374fcadf53-1774869636432",
    "dcName": "som-server-cbe",
    "dnsSuffix": "ECSOM.CBE.COM",
    "domainName": "ECSOM",
    "dmDomainID": "1",
    "name": "ECSOM",
    "guid": "fd7b9f4a4dbdb14b916eb513c12e43f9",
    "credentialID": "1",
    "isADDomain": true,
    "oauthType": null,
    "syncType": 1,
    "networkType": 2,
    "username": "Administrator"
  }
]
```

## Sample Response: HTTP 204

```text
204 No Content
```

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