Help Center/ KooDrive/ API Reference/ API/ Department Management/ Listing Departments

Updated on 2024-07-30 GMT+08:00

View PDF

Listing Departments

Function

List sub-departments under an organization or department. Only the top-level sub-departments are returned. To query sub-department of the lowest level, use the caller to perform recursive query.

URI

GET /koodrive/ose/v1/departmentList

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
departmentId	No	String	Department ID. If no value is passed, the root department ID is used.
keyWord	No	String	Search keyword. You can use name as the search criterion.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
X-Traceid	No	String	Message log trace ID. The value contains 58 bits.
language	No	String	Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response information.
data	Array of departmentInfo objects	Department list.

**Table 4** departmentInfo
Parameter	Type	Description
code	String	Response code.
msg	String	Response information.
id	String	Department ID.
orgId	String	ID of the organization created in OrgID.
deptId	String	ID of the department created in OrgID.
parentId	String	ID of the parent department in KooDrive.
name	String	Department name.
tenantId	String	Tenant ID.

Example Requests

Lists sub-departments under department 1245640257345455489.

GET /koodrive/ose/v1/departmentList?departmentId=1245640257345455489

Authorization:Bearer+10f88**********4791e9ff

Example Responses

Status code: 200

Returns the list of sub-departments under an organization or department.

{
  "list" : [ {
    "id" : "1248723349513736065",
    "orgId" : "9190086000001210958",
    "deptId" : "b06f091567064db9a1f6a7dc8d08e8a7",
    "parentId" : "1245640257345455489",
    "name" : "sub11rt",
    "tenantId" : "40086000004871666"
  }, {
    "id" : "1252924812435692416",
    "orgId" : "9190086000001210958",
    "deptId" : "f63c3008420c4c55b3963b6191096e2e",
    "parentId" : "1245640257345455489",
    "name" : "1234666",
    "tenantId" : "40086000004871666"
  } ],
  "code" : 0,
  "msg" : "success"
}