Last updated: 2020-08-18 11:30:17

1. API Description

Domain name for API request:

This API is used to obtain information on organizations.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: GetOrganization.
Version Yes String Common parameter. The value used for this API: 2018-12-25.
Region No String Common parameter. This parameter is not required for this API.

3. Output Parameters

Parameter Name Type Description
OrgId Integer Organization ID
HostUin Integer Creator UIN
Nickname String Creator's name
Mail String Creator's email address
OrgType Integer Organization type
IsEmpty Integer Whether the organization is empty or not
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining organization information

Input Example
&<Common Request Parameters>

Output Example

  "Response": {
    "OrgId": 1,
    "HostUin": 1,
    "Nickname": "test",
    "Mail": "",
    "OrgType": 1,
    "IsEmpty": 1,
    "RequestId": "629cde15-2b9c-403b-b5f1-033992709327"

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
ResourceNotFound.OrganizationNotExist The organization does not exist.
ResourceNotFound.UserNotExist The user does not exist.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback