Get department information

Retrieves the details of a specific enterprise department.

Important

The new Qoder CN documentation site is now available. Content on this site may not reflect the latest product features and changes. Visit docs.qoder.cn for the latest product documentation.

Supported editions

Enterprise Dedicated Edition

Service endpoints

Get the service endpoint and replace {domain} in the API request syntax with your endpoint.

Request syntax

GET https://{domain}/oapi/v1/platform/departments/{id}

Request	Get department information `curl -X 'GET' \ 'https://test-domain-*.rdc.aliyuncs.com/oapi/v1/platform/departments/{id}' \ -H 'Content-Type: application/json' \ -H 'x-yunxiao-token: pt-0fh30fbG_35af**0484'`
Request headers
`x-yunxiao-token` `string` (Required) The access token. See Access token for details. Example: pt-0fh3**0fbG_35af**0484.
Request parameters
id `string` Required The department ID. You can obtain this ID by calling the ListSysDepts operation.

Response parameters	Sample response `[ { "id": "ebeb5a64-c98c-478a-9d9d-513841da**", "name": "Enterprise Department", "creatorId": "dff43c50-75c5-4d17-86bf-3e900bc7", "parentId": "327cf4eb-6ef7-4f50-9a4f-7f4fd4d9**", "hasSub": true } ]`
id `string` The ID of the department.
name `string` The name of the department.
creatorId `string` The ID of the user who created the department.
parentId `string` The ID of the parent department.
hasSub `boolean` Specifies whether the department has subdepartments. `true`: The department has subdepartments. This parameter is omitted if the department has no subdepartments.

Error codes

For more information, see Error code center.

Service endpoints

Request syntax

Request

Request headers

Request parameters

Response parameters

Sample response

Error codes