Retrieve a Workspace
/v1/workspaces/{id}Read one authorized Workspace and effective membership. include=members adds its initial membership page.
Authentication
Use your signed-in console session or a person's WorkOS access token for this setup operation. See authentication and permissions.
Request
Responses
Workspace resource.
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
memberClassstringconditionalhasSignedInbooleanconditionaljoinedAtstringconditionalnextPageUrlstring | nullalways present