Help Center/Organizations/API Reference/APIs/Managing OUs/Listing OUs
Updated on 2026-03-05 GMT+08:00
View PDF

Listing OUs

Function

This API is used to list all OUs in an organization. If a parent OU is specified, this API will return a list of all the OUs contained in the specified parent OU. This API can be called only from the organization's management account or from a member account that is a delegated administrator for a cloud service.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    organizations:ous:list

    List

    -

    -

    -

    -

URI

GET /v1/organizations/organizational-units

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

parent_id

No

String

Unique ID of the parent node (root OU or another OU).

limit

No

Integer

Maximum number of results on the page. If the limit is not specified, the default value is 1,000.

marker

No

String

Pagination marker.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

organizational_units

Array of OrganizationalUnitDto objects

List of OUs in an organization.

page_info

PageInfoDto object

Pagination information.

Table 4 OrganizationalUnitDto

Parameter

Type

Description

id

String

Unique ID of an OU.

urn

String

Uniform resource name of the OU.

name

String

OU name.

created_at

String

Time when the OU was created.

Table 5 PageInfoDto

Parameter

Type

Description

next_marker

String

Marker for the next set of results. If present, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the next_marker response element comes back as null.

current_count

Integer

Number of items returned on the current page.

Example Requests

Listing OUs

GET https://{endpoint}/v1/organizations/organizational-units

Example Responses

Status code: 200

Successful

{
  "organizational_units" : [ {
    "id" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "name" : "autoOU0923152729270Pkgk",
    "created_at" : "2022-09-23T07:27:28Z"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}

Status Codes

Status Code

Description

200

Successful

Error Codes

See Error Codes.

Parent topic:Managing OUs