Get Bulk Organization Structure API

To retrieve multiple organization structure records.

Request URLs:

https://people.zoho.com/people/api/v3/orgstructure/entities
https://people.zoho.com/people/api/v3/orgstructure/units
https://people.zoho.com/people/api/v3/orgstructure/divisions

Scope:

ZOHOPEOPLE.orgstructure.ALL
ZOHOPEOPLE.orgstructure.READ

Request Type:

GET

Request Parameters:

ParameterDescriptionTypeAccepted Value / RangeDefault
offsetRepresents the pagination index to retrieve records.Integer-1 (retrieves the first page)
limitSpecifies the number of records to be retrieved per request.Integer1 to 200200
is_taggedIndicates the tag status of the records to be retrievedInteger0 (Unmapped)
1 (Mapped		Fetches all records 
(both mapped nand unmapped)

Note: Default refers to the behaviour when a parameter is not provided in the request.

Threshold Limit: 30 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Sample Request

Copiedhttps://people.zoho.com/people/api/v3/orgstructure/entities?is_tagged=0&limit=2&offset=1

Success Response - 200 OK

Copied{
  "data": [
    {
      "zp_code": "1",
      "name": "Comp1",
      "description": "FirstComp",
      "zoho_id": "10000200000027xxxx"
    },
    {
      "zp_code": "2",
      "name": "Comp2",
      "description": "SecondComp",
      "zoho_id": "10000200000027xxxx"
    }
  ],
  "has_more": true
}

Success Response: 200 OK - For Divisions

Copied{
  "data": [
   {
        "zp_code": "1",
        "parent_division": {},
         "name": "Div1",
         "description": "Managing division",
         "zoho_id": "100002000000289001"
    },
    {
        "zp_code": "2",
        "parent_division": {
              "name": "Div1",
              "zoho_id": "100002000000289001"
      },
      "name": "Div2",
       "description": "Employee Division",
       "zoho_id": "100002000000297001"
    }
  ],
  "has_more": false
}

Success Response - 204 No Content

CopiedThis indicates that the request was successful, but there is no data to return.