Querying the Organization List

Function

This API is used to query a specified organization and its sub-organizations.

Constraints

null

URI

GET /api/v2/tenant/organizations

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
all_child	No	Boolean	Whether to obtain sub-organizations of all levels.
limit	Yes	Integer	Number of data records on each page.
offset	Yes	Integer	Page number.
org_id	No	String	Organization ID. When the value of org_id is null and that of all_child is false, all root organizations (organizations of the highest level) are returned. When the value of org_id is null and that of all_child is true, in addition to the returned root organization, all sub-organizations are returned. When the value of org_id is orgId and that of all_child is true, this organization and its sub-organizations of all levels are returned. When the value of org_id is orgId and that of all_child is false, this organization and its lower-level organizations are returned.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Long	Total number of organizations.
organizations	Array of ResponseOrgInfo objects	Organization list.

**Table 4** ResponseOrgInfo
Parameter	Type	Description
org_id	String	Organization ID.
org_code	String	Organization ID, which is globally unique.
name	String	Organization name, which is unique at the corresponding level.
parent_id	String	Parent organization ID.
category	String	Organization type.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error details.

Example Requests

Query an organization list in pagination mode. In addition to the returned root organization, the first 100 sub-organizations are returned. If the number of records is less than 100, all the records are returned.

GET https://{domain_name}/api/v2/tenant/organizations?org_id=&all_child=true&offset=0&limit=100

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

Example Responses

Status code: 200

Request successful.

{
  "total" : 2,
  "organizations" : [ {
    "org_code" : "1000000",
    "org_id" : "20210619175242949-6040-CA7ECF...",
    "name" : "Headquarter",
    "category" : "department",
    "parent_id" : null
  }, {
    "org_code" : "1000001",
    "org_id" : "20210623103509267-6ABA-201FFC...",
    "name" : "Subdepartments",
    "category" : "department",
    "parent_id" : "20210619175242949-6040-CA7ECF..."
  } ]
}