Query Information of an Organization

Request URL

GET {base_url}/{api_path}/organization/get?access_token={access_token}

Request parameters

Table 1.
Parameter	Required	Type	Description
id	Yes	Integer	The unique ID of the organization. Note: You can query the organization's ID using Search Specific Organizations.

Response parameters

Table 2.
Parameter	Type	Description
errcode	Integer	Returned error code. `0`: Succeed. Non-zero value: Failed. Note: You can check the error code and error message in Error Code and Error Message.
errmsg	String	Returned message. `SUCCESS`: Succeed. `FAILURE`: Failed.
organization_info	Object<Organizaiton_Info>	The information of the organization.

Organization_Info

Table 3.
Parameter	Type	Description
id	Integer	Organization ID.
name	String	Organization name.
parent_id	Integer	Parent organization ID.
order	Integer	The sequence number of the organization.

Examples

Request example

GET /openapi/v1.0/organization/get?id=33&access_token=WLHdAu2gbn0eGCrHx0beDZg8CK1VCQIF HTTP/1.1 

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "organization_info": {
        "id": 33,
        "name": "tech support",
        "parent_id": 1,
        "order": 1
    }
}