Retrieve all networks the user belongs to

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieve all networks, or portals, that the authenticated user is a part of. Returns info such as the network name, ID, URL, logo, and whether it is the default network. For intranet networks, additional organization details such as zoid are also included.

Endpoints

Request URL

https://ServerDomain/pulse/api/allScopes

Scope

ZohoPulse.networklist.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

PARAM NAMEDATA TYPEDESCRIPTION
scopeID Long

Optional network (scope) ID to filter results to a specific network.

isAdmin Boolean

If true, returns only networks where the user is an admin.

Sample Request

Curl
C#
Java
Python
Deluge
Copied!
curl --request GET \
  --url 'https://connect.zoho.com/pulse/api/allScopes?scopeID=3000000000008&isAdmin=true' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
PARAM NAMEDATA TYPEDESCRIPTION
allScopes JSON Object

Inner allScopes object — contains scopes array on success, or error keys on failure

msg String

Error message. Present on failure.

result String

Result status — 'failure'. Present on failure.

errorCode String

Error code — e.g. NO_NETWORKS_FOUND. Present on failure.

scopes JSON Array

Array of network objects. Present on success.

soid String

Scope owner ID — the organization identifier.

isDefault String

'true' if this is the user's default (intranet) network.

name String

Display name of the network.

scopeUrl String

Scope URL slug. Present when a custom domain is configured.

zoid String

Zoho Organization ID. Present only for intranet-type networks.

id String

Unique network (scope) ID.

url String

Full portal URL of the network.

customDomain String

Custom domain mapped to the network, if configured.

logoUrl String

URL of the network logo image, if set.

Possible Response Codes

HTTP CodeDescription
200

Success response

Sample Response: HTTP 200

Returns all networks the authenticated user belongs to. The first scope with isDefault=true is the user's intranet network. The zoid and logoUrl fields are present based on network type and configuration.

Copied!
  {
    "allScopes": {
      "scopes": [
        {
          "soid": "38523447",
          "isDefault": "true",
          "name": "Zillium",
          "zoid": "15065798",
          "id": "3000000000008",
          "url": "https://connect.zoho.com/portal/zillium",
          "logoUrl": "https://profile.zoho.com/file/download?ID=15065798&t=org"
        },
        {
          "soid": "47445865",
          "name": "Zillium Partners",
          "id": "4000000000008",
          "url": "https://connect.zoho.com/portal/zilliumpartners",
          "logoUrl": "https://connect.zoho.com/images/zohoPulseLogo.png"
        }
      ]
    }
  }
                
Show full

Returned when the user does not belong to any network.

Copied!
  {
    "allScopes": {
      "msg": "No networks found",
      "result": "failure",
      "errorCode": "NO_NETWORKS_FOUND"
    }
  }
                
Show full

Duration: 1 minute | Threshold: 10 | Lock period: 1 minute

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.