Query organization information

Updated at:

Call this API to query organization information.

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.

Authorization information

Product

Resource

Required permission

Organization Management

Organization

Read Only

Request syntax

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

Request description

Query organization information

curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/organizations/99d1****71d4' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Request headers (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)

Organization ID. You can go to the Basic Information page in the organization management console to obtain the organization ID (organizationId).

Response parameters

Response example

 {
    "createdAt": "2023-08-31T03:59:16.201Z",
    "creatorId": "99d1****6124",
    "defaultRole": "99d1****6124",
    "description": "Example description",
    "id": "99d1****6124",
    "name": "Example name",
    "updateAt": "2023-08-31T03:59:16.201Z"
}

createdAt string

The time when the organization was created.

creatorId string

The creator of the organization.

defaultRole string

The default role.

description string

The description of the organization.

id string

The organization ID.

name string

The name of the organization.

updateAt string

The update time.

Error codes

For more information, see Error code center.