List Workspaces
/v1/workspacesList Workspaces visible to the signed-in person, with their effective role. personal=all also lists colleagues' personal Workspaces when the caller has permission; otherwise the list stays limited to directly assigned personal Workspaces.
Authentication
Use your signed-in console session or a person's WorkOS access token for this setup operation. See authentication and permissions.
Request
Responses
One bounded resource page. Follow nextPageUrl unchanged; the authenticated page retains caller, active organization, filters and limit. Access is rechecked on every request. Administration lists use live keyset reads and may change between pages.
objectstringalways presentAllowed: "list"
urlstringalways presentdataarrayalways presentShow item fields
namestringalways presentDisplay name. Renaming does not change the Workspace ID.
statusstringalways presentCurrent Workspace lifecycle state.
kindstringalways presentShared Workspace or provisioned personal Default Workspace. Personal Workspaces have separate lifecycle rules.
ownerUserIdstringconditionalOwner of a personal Workspace, when applicable.
synthesisCadencestringconditionalConfigured consolidation cadence, when set.
createdByUserIdstringalways presentPerson who created the Workspace.
createdAtstringalways presentRecorded Workspace creation time.
updatedAtstringalways presentRecorded Workspace configuration update time.
_etagstringconditionalRevision for an If-Match update or archive, when available.
workspaceRolestringconditionalThe signed-in person's effective Workspace role, when loaded.
viastringconditionalSource of effective access, such as direct or inherited membership, when loaded.
membersobjectconditionalInitial membership page, loaded by include=members on the detail read. Follow its nextPageUrl for more.
Show nested fields
objectstringalways presentAllowed: "list"
urlstringalways presentdataarrayalways presentShow item fields
objectstringalways presentAllowed: "organization_member""workspace_member"
idstringalways presentMin length: 1
userIdstringalways presentMin length: 1
organizationstringalways presentworkspacestringconditionalnamestringconditionalemailstringconditionalrolestringconditionalworkspaceRolestringconditionalorgRolestringconditionalviastringconditionaladdedAtstringconditionaladdedByUserIdstringconditionalpermissionsarrayconditionalShow item fields
See the complete schema in the OpenAPI specification.
memberClassstringconditionalhasSignedInbooleanconditionaljoinedAtstringconditionalnextPageUrlstring | nullalways presentnextPageUrlstring | nullalways presentorganizationobjectalways presentShow nested fields
namestringalways presentOrganization display name.
rolestringconditionalThe signed-in person's organization role, when loaded.
workosOrgIdstringconditionalExternal identity-provider reference, when present. Resource routes use id instead.
memberCountinteger | nullalways presentFull roster count, or null when the roster has not been read.
Minimum: 0
membersobjectconditionalInitial membership page, loaded by include=members on the detail read. Follow its nextPageUrl for more.
Show nested fields
objectstringalways presentAllowed: "list"
urlstringalways presentdataarrayalways presentShow item fields
objectstringalways presentAllowed: "organization_member""workspace_member"
idstringalways presentMin length: 1
userIdstringalways presentMin length: 1
organizationstringalways presentworkspacestringconditionalnamestringconditionalemailstringconditionalrolestringconditionalworkspaceRolestringconditionalorgRolestringconditionalviastringconditionaladdedAtstringconditionaladdedByUserIdstringconditionalpermissionsarrayconditionalShow item fields
See the complete schema in the OpenAPI specification.
memberClassstringconditionalhasSignedInbooleanconditionaljoinedAtstringconditionalnextPageUrlstring | nullalways present