Querying Organization Details

Function

This API is used to query organization details by organization ID.

Constraints

null

URI

GET /api/v2/tenant/organizations/{org_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
org_id	Yes	String	Organization ID.

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
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 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error details.

Example Requests

Query an organization details based on the organization ID.

GET https://{domain_name}/api/v2/tenant/organizations/{org_id}

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

Example Responses

Status code: 200

Request successful.

{
  "org_id" : "20220412142914549-1E50-B49C521A4",
  "parent_id" : "20220412105608948-3B83-D566C6D94",
  "name" : "Testing organization",
  "category" : "department",
  "org_code" : "TestOrg"
}