Skip to main content

Workspaces

Tags: organizations, workspaces

Organization workspace management

Resources​

Request and response models used by the endpoints on this page.

OrgWorkspaceResponse​

FieldTypeRequiredDescription
allowSignupBooleanDefault: False
createdAtString✓
creatorIdInteger
creatorNameString
featureStatusdict[str, str]
featuresArray
idInteger✓
isMemberBooleanDefault: False
isPublicBooleanDefault: False
labelsArray<WorkspaceLabelSummary>
localeString
nameString✓
organizationIdInteger✓
organizationNameString
organizationUuidString
resellerIdInteger
setupBundleOutcomeSetupBundleOutcome
setupBundleUuidString
signupCodeString
slugString✓
statusInteger✓
timezoneString
uuidString✓

Example:

{
"id": 0,
"uuid": "string",
"slug": "string",
"name": "string",
"organizationId": 0,
"createdAt": "string",
"isPublic": false,
"allowSignup": false,
"status": 0,
"isMember": false
}

PaginatedResponse[OrgWorkspaceResponse]​

FieldTypeRequiredDescription
itemsArray<OrgWorkspaceResponse>✓
pageInteger✓
pageSizeInteger✓
totalInteger✓
totalPagesInteger✓

Example:

{
"items": [],
"total": 0,
"page": 0,
"pageSize": 0,
"totalPages": 0
}

WorkspaceLabelSummary​

FieldTypeRequiredDescription
colorString✓
nameString✓
slugString✓
uuidString✓

Example:

{
"uuid": "string",
"slug": "string",
"name": "string",
"color": "string"
}

Endpoints​

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: 1
  • pageSize (Integer) — min: 1, max: 100
  • sortBy (AdminWorkspaceSortField)
  • sortOrder (SortOrder)
  • search (String)

Response: See PaginatedResponse[OrgWorkspaceResponse]