Contact Us
Log In

Query Sub-Organization List

Last Updated on : 2021-07-16 08:15:49download

Query the list of sub-organizations by organization ID.

API address

GET: /v1.0/iot-03/organizations/{org_id}/sub-organizations

Request parameter

Parameter name Type IN Required Description
org_id String uri true The ID of a specified organization. -1 is set to query the list of the first-level organizations.
organization_query_sub_list_req OrganizationQuerySubListReq query true The request parameter of querying the sub-organization list.

Description of organization_query_sub_list_req

Parameter name Type IN Required Description
last_row_key String false The primary key ID of the last entry.
page_size Integer false The number of entries per page.

Return parameter

Parameter name Type Description
result CursorPage The returned results on pages.

Description of result

Parameter name Type Description
has_more Boolean Specifies whether to return the next page.
list List The list of organizations.
last_row_key String The primary key of the last entry.

Description of list

Parameter name Type Description
id String The organization ID.
name String The name of a specified organization.
parent_id String The ID of the parent organization.
external_id String The ID of an external organization.

Request example

GET: /v1.0/iot-03/organizations/-1/sub-organizations

Return example

{ "result": { "last_row_key": "1398180274893840384", "list": [ { "external_id": "Organization 2021052815316666", "parent_id": "", "name": "Organization 20210528153166666", "id": "1398180274893840384" } ], "has_more": false }, "t": 1624073279037, "success": true }

Error code

For more information, see error code.