Workspaces
Tags: organizations, workspaces
Organization workspace management
Resources
Request and response models used by the endpoints on this page.
OrgWorkspaceResponse
| Field | Type | Required | Description |
|---|---|---|---|
allowSignup | Boolean | Default: False | |
createdAt | String | ✓ | |
creatorId | Integer | ||
creatorName | String | ||
featureStatus | dict[str, str] | ||
features | Array | ||
id | Integer | ✓ | |
isMember | Boolean | Default: False | |
isPublic | Boolean | Default: False | |
labels | Array<WorkspaceLabelSummary> | ||
locale | String | ||
name | String | ✓ | |
organizationId | Integer | ✓ | |
organizationName | String | ||
organizationUuid | String | ||
resellerId | Integer | ||
setupBundleOutcome | SetupBundleOutcome | ||
setupBundleUuid | String | ||
signupCode | String | ||
slug | String | ✓ | |
status | Integer | ✓ | |
timezone | String | ||
uuid | String | ✓ |
Example:
{
"id": 0,
"uuid": "string",
"slug": "string",
"name": "string",
"organizationId": 0,
"createdAt": "string",
"isPublic": false,
"allowSignup": false,
"status": 0,
"isMember": false
}
PaginatedResponse[OrgWorkspaceResponse]
| Field | Type | Required | Description |
|---|---|---|---|
items | Array<OrgWorkspaceResponse> | ✓ | |
page | Integer | ✓ | |
pageSize | Integer | ✓ | |
total | Integer | ✓ | |
totalPages | Integer | ✓ |
Example:
{
"items": [],
"total": 0,
"page": 0,
"pageSize": 0,
"totalPages": 0
}
WorkspaceLabelSummary
| Field | Type | Required | Description |
|---|---|---|---|
color | String | ✓ | |
name | String | ✓ | |
slug | String | ✓ | |
uuid | String | ✓ |
Example:
{
"uuid": "string",
"slug": "string",
"name": "string",
"color": "string"
}
Endpoints
GET /api/v2/o/{org_uuid}/workspaces- List Organization Workspaces
List Organization Workspaces
GET /api/v2/o/{org_uuid}/workspaces
Description:
List the organization's workspaces, one page at a time.
page starts at 1. pageSize defaults to 10 and is at most 100, so read
pages until page reaches totalPages to collect every workspace.
search matches part of a workspace's name, slug or uuid, ignoring case.
sortBy is name (the default), slug or createdAt; sortOrder is
asc (the default) or desc.
Authentication: Requires org:read on the organization. Organization admins and owners hold it; other organization members receive 403. An API key is limited to the scopes it was created with, so it must also carry org:read.
Parameters:
page(Integer) — min: 1pageSize(Integer) — min: 1, max: 100sortBy(AdminWorkspaceSortField)sortOrder(SortOrder)search(String)
Response: See PaginatedResponse[OrgWorkspaceResponse]