List organization workspace summaries

Returns active workspaces in the current region by default. Use cross_region=true to include peer-region workspaces. Peer-region workspaces come from the reporting copy and can lag. They appear only for organizations in the reporting replication. A failed peer workspace read returns reporting_region_unavailable. Use fields to request access counts and attached SSO connections. Requires organization administration. Counts follow the users list visibility rules. Each person counts once per workspace. Membership wins over pending entries. A transfer-required owner counts only as transfer_required. Other pending entries use seat_denied, assigned, invited, then expired precedence. Search matches a part of the workspace name without regard to case. Sort by name, ascending by default. Workspace id breaks ties. Use first and after to page forward, with at most 100 workspaces per page. A cursor of another organization, cross_region value, search or sort returns 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Query Params
fields
array of strings

Optional fields. access_counts includes member_count and all pending counts. Requested fields are null for peer-region workspaces.

OrganizationWorkspaces.Fields
Allowed:
boolean
Defaults to false

Include peer-region workspaces for a multi-regional organization.

order_by
array of strings
OrganizationWorkspaces.OrderBy
Allowed:
order_directions
array of strings
OrganizationWorkspaces.OrderDirections
Allowed:
integer | null

The number of records to return after the provided cursor; used in combination with after

integer | null

The number of records to return for before the provided cursor; used in combination with before

string | null

A base64 encoded value representing a cursor, or an element ID if applicable

string | null

A base64 encoded value representing a cursor, or an element ID if applicable

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json