Skip to content
AugentaDocsOpen console ↗
List Workspaces

Documentation

API reference
View Markdown

List Workspaces

GET/v1/workspaces

List 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

Parameters

limitintegeroptional

query parameter.

Minimum: 1Maximum: 200

Default: 50

pagestringoptional

query parameter.

Min length: 1Max length: 4096

personalstringoptional

query parameter.

Allowed: "all"

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 present

Allowed: "list"

urlstringalways present
dataarrayalways present
Show item fields
objectstringalways present

The resource type. Always workspace.

Allowed: "workspace"

idstringalways present

Workspace identity used in routes and memory selectors.

Min length: 1

orgIdstringalways present

Owning Organization's Augenta ID.

Min length: 1

namestringalways present

Display name. Renaming does not change the Workspace ID.

statusstringalways present

Current Workspace lifecycle state.

kindstringalways present

Shared Workspace or provisioned personal Default Workspace. Personal Workspaces have separate lifecycle rules.

ownerUserIdstringconditional

Owner of a personal Workspace, when applicable.

synthesisCadencestringconditional

Configured consolidation cadence, when set.

createdByUserIdstringalways present

Person who created the Workspace.

createdAtstringalways present

Recorded Workspace creation time.

updatedAtstringalways present

Recorded Workspace configuration update time.

_etagstringconditional

Revision for an If-Match update or archive, when available.

workspaceRolestringconditional

The signed-in person's effective Workspace role, when loaded.

viastringconditional

Source of effective access, such as direct or inherited membership, when loaded.

membersobjectconditional

Initial membership page, loaded by include=members on the detail read. Follow its nextPageUrl for more.

Show nested fields
objectstringalways present

Allowed: "list"

urlstringalways present
dataarrayalways present
Show item fields
objectstringalways present

Allowed: "organization_member""workspace_member"

idstringalways present

Min length: 1

userIdstringalways present

Min length: 1

organizationstringalways present
workspacestringconditional
namestringconditional
emailstringconditional
rolestringconditional
workspaceRolestringconditional
orgRolestringconditional
viastringconditional
addedAtstringconditional
addedByUserIdstringconditional
permissionsarrayconditional
Show item fields

See the complete schema in the OpenAPI specification.

memberClassstringconditional
hasSignedInbooleanconditional
joinedAtstringconditional
nextPageUrlstring | nullalways present
nextPageUrlstring | nullalways present
organizationobjectalways present
Show nested fields
objectstringalways present

The resource type. Always organization.

Allowed: "organization"

idstringalways present

Augenta Organization ID used in resource routes.

Min length: 1

namestringalways present

Organization display name.

rolestringconditional

The signed-in person's organization role, when loaded.

workosOrgIdstringconditional

External identity-provider reference, when present. Resource routes use id instead.

memberCountinteger | nullalways present

Full roster count, or null when the roster has not been read.

Minimum: 0

membersobjectconditional

Initial membership page, loaded by include=members on the detail read. Follow its nextPageUrl for more.

Show nested fields
objectstringalways present

Allowed: "list"

urlstringalways present
dataarrayalways present
Show item fields
objectstringalways present

Allowed: "organization_member""workspace_member"

idstringalways present

Min length: 1

userIdstringalways present

Min length: 1

organizationstringalways present
workspacestringconditional
namestringconditional
emailstringconditional
rolestringconditional
workspaceRolestringconditional
orgRolestringconditional
viastringconditional
addedAtstringconditional
addedByUserIdstringconditional
permissionsarrayconditional
Show item fields

See the complete schema in the OpenAPI specification.

memberClassstringconditional
hasSignedInbooleanconditional
joinedAtstringconditional
nextPageUrlstring | nullalways present