ListOrganizationalUnits

Print
Dark
Light

ListOrganizationalUnits

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/v1/organizations/{organizationId}/organizationalUnits

Availability
Early Access: Planned; date not yet confirmed
Early Access is gated; contact the Backblaze Sales team for access.
Limited Availability: Planned; date not yet confirmed
This API is available only to customers with access to the Backblaze Enterprise Web Console. For more information, contact the Backblaze Sales team.

List organizational units under an organization

Returns the immediate child Organizational Units of the given organization. Organizational Unit nesting is not currently supported.

Results are fully consistent, and the caller must have permission to list the entire collection at that level or the request fails.

Security

HTTP

Type bearer

Short-lived bearer token obtained from GET /orgs/v1/authorize. Sent as Authorization - Bearer .

Path parameters

organizationId

stringRequired

The opaque identifier of the organization.

Pattern^[a-z0-9_-]{8,64}$

Exampleorg-acme-prod

Query parameters

showDeleted

boolean

If true, include resources in the DELETED state. Defaults to false.

Defaultfalse

pageSize

integer

Maximum number of items to return. Default 50, maximum 1000.

Minimum1

Maximum1000

Default50

pageToken

string

Opaque pagination token returned from a previous List response.

Responses

200

The request succeeded.

{
  "organizationalUnits": [
    {
      "name": "organizationalUnits/ou-prod",
      "parent": "organizations/org-acme-prod",
      "displayName": "Production",
      "etag": "BwXk9a2J8p0=",
      "createTime": "2026-02-06T22:55:33Z",
      "updateTime": "2026-02-06T22:55:33Z"
    }
  ],
  "nextPageToken": "eyJwYWdlIjoyfQ=="
}

Expand All

object

organizationalUnits

Array of object (OrganizationalUnit)

object

name

string

Resource name in the form organizationalUnits/.

ExampleorganizationalUnits/ou-prod

parent

string

Parent resource name in the form organizations/. Organizational Unit nesting is not currently supported.

Exampleorganizations/org-acme-prod

displayName

string

ExampleProduction

etag

string

ExampleBwXk9a2J8p0=

createTime

string (date-time)

updateTime

string (date-time)

nextPageToken

string | null

401

The request was not authenticated.

HTTP Status	Code	Description
401	UNAUTHORIZED	Missing, expired, or invalid bearer token.

Expand All

object

requestId

string

Opaque correlation identifier matching the Request-Id response header. Include in support requests.

Example4bf92f3577b34da6a3ce929d0e0e4736

error

object

code

integer

Numeric error code.

Example10

message

string

Human-readable description of the error.

Exampleetag mismatch

details

object

Reserved for structured, non-sensitive diagnostic information related to the error condition.

403

The caller is not authorized to perform this operation.

HTTP Status	Code	Description
403	FORBIDDEN	The authenticated principal lacks permission for this action.

Expand All

object

requestId

string

Opaque correlation identifier matching the Request-Id response header. Include in support requests.

Example4bf92f3577b34da6a3ce929d0e0e4736

error

object

code

integer

Numeric error code.

Example10

message

string

Human-readable description of the error.

Exampleetag mismatch

details

object

Reserved for structured, non-sensitive diagnostic information related to the error condition.

429

The request was rate-limited.

HTTP Status	Code	Description
429	TOO_MANY_REQUESTS	Rate limit exceeded. Use exponential backoff.

Expand All

object

requestId

string

Opaque correlation identifier matching the Request-Id response header. Include in support requests.

Example4bf92f3577b34da6a3ce929d0e0e4736

error

object

code

integer

Numeric error code.

Example10

message

string

Human-readable description of the error.

Exampleetag mismatch

details

object

Reserved for structured, non-sensitive diagnostic information related to the error condition.

500

The server encountered an unexpected condition.

HTTP Status	Code	Description
500	INTERNAL	Unexpected server error. Include the `requestId` when contacting support.

Expand All

object

requestId

string

Opaque correlation identifier matching the Request-Id response header. Include in support requests.

Example4bf92f3577b34da6a3ce929d0e0e4736

error

object

code

integer

Numeric error code.

Example10

message

string

Human-readable description of the error.

Exampleetag mismatch

details

object

Reserved for structured, non-sensitive diagnostic information related to the error condition.

Was this article helpful?

What's Next

GetOrganizationalUnit