Retrieves all groups in a network

Returns all groups in the network, including both joined and not joined groups. Each result includes details such as group identity, access type, membership status, and creator information. Unlike userGroups, which returns only your groups, this returns all groups you can view.

Endpoints

get /pulse/api/allGroups

Copy full URL

Request URL

https://ServerDomain/pulse/api/allGroups

Scope

ZohoPulse.userDetail.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

PARAM NAME	DATA TYPE	DESCRIPTION
isAscSort	Boolean	If true, sorts in ascending order. If false, descending.
scopeID	Long	Network (scope) ID.
limit	Integer	Maximum number of groups to return.
isRecentSort	Boolean	If true, sorts groups by created time instead of alphabetically.
isGroupsMetaNeeded	Boolean	If true (default), includes group metadata like role and joined status.
includeDefaultPartition	Boolean	If true, includes the default partition (Company Wall) in the response.
isFavouriteNeeded	Boolean	If true (default), includes favourite status for each group.

Sample Request

Curl

Java

Python

Deluge

Copied!

curl --request GET \
  --url 'https://connect.zoho.com/pulse/api/allGroups?isAscSort=true&scopeID=3000000000008&limit=10&isRecentSort=true&isGroupsMetaNeeded=true&includeDefaultPartition=true&isFavouriteNeeded=true' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

var client = new RestClient("https://connect.zoho.com/pulse/api/allGroups?isAscSort=true&scopeID=3000000000008&limit=10&isRecentSort=true&isGroupsMetaNeeded=true&includeDefaultPartition=true&isFavouriteNeeded=true");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52");
IRestResponse response = client.Execute(request);

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://connect.zoho.com/pulse/api/allGroups?isAscSort=true&scopeID=3000000000008&limit=10&isRecentSort=true&isGroupsMetaNeeded=true&includeDefaultPartition=true&isFavouriteNeeded=true"))
        .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("connect.zoho.com")

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

conn.request("GET", "/pulse/api/allGroups?isAscSort=true&scopeID=3000000000008&limit=10&isRecentSort=true&isGroupsMetaNeeded=true&includeDefaultPartition=true&isFavouriteNeeded=true", headers=headers)

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

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


    parameters = "isAscSort=value" + "&" + "scopeID=value" + "&" + "limit=value" + "&" + "isRecentSort=value" + "&" + "isGroupsMetaNeeded=value" + "&" + "includeDefaultPartition=value" + "&" + "isFavouriteNeeded=value";

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

    response = invokeUrl
    [
        url: "https://connect.zoho.com/pulse/api/allGroups" + "?" + parameters
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

PARAM NAME	DATA TYPE	DESCRIPTION
allGroups	JSON Object	Inner allGroups object — groups array on success, error keys on failure
result	String	'failure' on error.
reason	String	Error message. Present on failure.
groups	JSON Array	Array of group objects. Each has same structure as userGroups.
typeOrd	String	Ordinal of the partition type.
role	String	Caller's role in this group: ADMIN or MEMBER.
partitionUrl	String	URL slug of the group.
isPrivate	String	'true' if the group is private.
type	String	Partition type: GROUP, DEFAULT.
userDetails	JSON Object	Group creator details.
name	String	Display name of the creator.
canFollow	String	'true' if the caller can follow this user.
id	String	User ID (same as zuid).
zuid	String	Zoho User ID of the creator.
url	String	URL path of the group.
isJoined	String	'true' if the caller is a member of this group.
accessType	String	Access type: PRIVATE, OPEN_PUBLIC, REQUEST_PUBLIC, ALL_HANDS, SAMPLE.
isClosed	String	'true' if the group is closed (requires invitation to join).
bgColor	String	Background color hex code for the group avatar.
showInFeed	String	'true' if the favourite group appears in the feed. Present with isFavourite.
clientSharedInfo	String	Client shared info message. Present when the group is shared with clients.
name	String	Group display name.
logo	String	Short text logo (initials) for the group.
subType	String	Group sub-type: DEFAULT.
canJoin	String	'true' if the caller can join this group.
canDelete	String	'true' if the caller can delete this group. Present for admins.
id	String	Group ID.
time	String	Group created time as epoch milliseconds.
isFavourite	String	'true' if the group is in the caller's favourites. Present when isFavouriteNeeded=true.
isUserFollow	String	'true'/'false' — whether the caller follows this group.
status	String	Group status: ACTIVE, LOCK.
desc	String	Group description. Present when set.
errorCode	String	Machine-readable error code. Present on failure.

Possible Response Codes

HTTP Code	Description
200	Success response

Sample Response: HTTP 200

All groups in the network (joined and not-joined).

Copied!

  {
    "allGroups": {
      "groups": [
        {
          "typeOrd": "2",
          "role": "ADMIN",
          "partitionUrl": "engineering",
          "isPrivate": "true",
          "type": "GROUP",
          "userDetails": {
            "name": "Jane Doe",
            "canFollow": "true",
            "id": "15065799",
            "zuid": "15065799"
          },
          "url": "engineering",
          "isJoined": "true",
          "accessType": "PRIVATE",
          "bgColor": "45B5DB",
          "isClosed": "true",
          "name": "Engineering",
          "logo": "EN",
          "subType": "DEFAULT",
          "canJoin": "false",
          "canDelete": "true",
          "id": "3000000002143",
          "time": "1719915898000",
          "isUserFollow": "false",
          "status": "ACTIVE"
        },
        {
          "typeOrd": "2",
          "role": "ADMIN",
          "partitionUrl": "engineering",
          "isPrivate": "true",
          "type": "GROUP",
          "userDetails": {
            "name": "Jane Doe",
            "canFollow": "true",
            "id": "15065799",
            "zuid": "15065799"
          },
          "url": "engineering",
          "isJoined": "true",
          "accessType": "PRIVATE",
          "bgColor": "45B5DB",
          "isClosed": "true",
          "name": "Engineering 2",
          "logo": "EN",
          "subType": "DEFAULT",
          "canJoin": "false",
          "canDelete": "true",
          "id": "3000000002144",
          "time": "1720002298000",
          "isUserFollow": "false",
          "status": "ACTIVE"
        }
      ]
    }
  }

▼ Show full

Returned when the scopeID is invalid.

Copied!

  {
    "allGroups": {
      "result": "failure",
      "reason": "Looks like you do not have access to the network you have entered. Please check the URL and try again.",
      "errorCode": "1022"
    }
  }

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