Retrieves sections and details for a board

Retrieves the complete details of a specific board, including its sections, members, permissions, tags, and statistics. You can identify the board using boardId or boardUrl. This API also checks access permissions and supports shared board access.

Endpoints

get /pulse/api/boardSections

Copy full URL

Request URL

https://ServerDomain/pulse/api/boardSections

Scope

ZohoPulse.tasks.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

PARAM NAME	DATA TYPE	DESCRIPTION
scopeIDMandatory	Long	Network (scope) ID. Required.
boardId	Long	Board ID. Provide either boardId or boardUrl.
boardUrl	String Allowed value:(matches: ^[0-9a-zA-Z\-\%\P{InBasicLatin}]+$)	Board URL slug. Used to resolve the board if boardId is not provided.

Sample Request

Curl

Java

Python

Deluge

Copied!

curl --request GET \
  --url 'https://connect.zoho.com/pulse/api/boardSections?scopeID=3000000000008&boardId=3000000050001' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

var client = new RestClient("https://connect.zoho.com/pulse/api/boardSections?scopeID=3000000000008&boardId=3000000050001");
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/boardSections?scopeID=3000000000008&boardId=3000000050001"))
        .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/boardSections?scopeID=3000000000008&boardId=3000000050001", headers=headers)

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

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


    parameters = "scopeID=value" + "&" + "boardId=value";

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

    response = invokeUrl
    [
        url: "https://connect.zoho.com/pulse/api/boardSections" + "?" + 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
boardSections	JSON Object	Inner boardSections object — sections, members, board detail
result	String	Result status — 'failure'. Present on failure.
isArchivedSections	String	'true' if archived sections exist.
members	JSON Array	Array of board member detail objects.
role	String	Member role — ADMIN or MEMBER.
name	String	Display name.
hasCustomImg	Boolean	True if user has a custom profile image.
id	Long	Internal user ID.
email	String	Email address.
zuid	Long	Zoho UID.
status	String	Member status — ACTIVE.
errorCode	String	Error code. Present on failure.
sections	JSON Array	Array of section objects.
taskCount	Integer	Number of tasks in section.
name	String	Section name.
colorCode	String	Header colour hex (native API only).
id	Long	Section ID.
isPrivate	Boolean	True if section is private.
colourType	Integer	Section colour index.
vcardEmailId	String	Section email address (if enabled).
url	String	Section URL.
board	JSON Object	Board detail object.
typeOrd	Integer	Partition type ordinal.
partitionUrl	String	Board URL slug.
isPrivate	Boolean	True if board is private.
isAdmin	String	'true' if caller is board admin.
type	String	Partition type — PROJECT.
url	String	Board URL path.
users	JSON Array	Array of member user IDs.
sections	JSON Array	Array of board sections.
taskCount	Integer	Number of tasks in section.
name	String	Section name.
colorCode	String	Header colour hex (native API only).
id	Long	Section ID.
isPrivate	Boolean	True if section is private.
colourType	Integer	Section colour index.
vcardEmailId	String	Section email address (if enabled).
url	String	Section URL.
canCreateSection	String	'false' if caller cannot create sections.
name	String	Board name.
subType	String	Board sub-type (e.g. DEFAULT, SCRUM).
id	Long	Board ID.
isUserFollow	Boolean	True if caller follows the board.
status	String	Entity status (ACTIVE, ARCHIVED, etc.).
canCreateTask	String	'false' if caller cannot create tasks.

Possible Response Codes

HTTP Code	Description
200	Success response

Sample Response: HTTP 200

Board sections retrieved successfully.

Copied!

  {
    "boardSections": {
      "members": [
        {
          "role": "ADMIN",
          "name": "John Doe",
          "hasCustomImg": true,
          "id": 700000001,
          "email": "john.doe@zillium.com",
          "zuid": 700000001,
          "status": "ACTIVE"
        },
        {
          "role": "ADMIN",
          "name": "John Smith",
          "hasCustomImg": false,
          "id": 700000002,
          "email": "john.smith@zillium.com",
          "zuid": 700000002,
          "status": "ACTIVE"
        }
      ],
      "sections": [
        {
          "taskCount": 5,
          "name": "To Do",
          "id": 3000000050010,
          "isPrivate": false,
          "colourType": 2,
          "url": "to-do"
        },
        {
          "taskCount": 3,
          "name": "In Progress",
          "id": 3000000050011,
          "isPrivate": false,
          "colourType": 4,
          "url": "in-progress"
        }
      ],
      "board": {
        "partitionUrl": "sprint-board",
        "name": "Sprint Board",
        "id": 3000000050001,
        "isAdmin": "true",
        "type": "PROJECT",
        "status": "ACTIVE"
      }
    }
  }

▼ Show full

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