Skip to main content
GET
Get workspace
Returns one workspace by ID, including its computers under desktops. Owners and invited members both have read access. A workspace-scoped API key can read only the workspace it is scoped to. Any other ID returns 403. See Authentication.

Path parameters

string
required
Workspace ID. Required.

Response

string
Workspace identifier.
string
Workspace name.
string
User ID of the workspace owner.
string
Workspace status. active for a normal workspace.
string
Icon URL, or null when none is set.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
string
Subscription tier of the workspace owner. Computers are funded by the owner’s plan, so this is the tier that sets the hardware ceiling for every computer in the workspace.
string
Email address of the workspace owner. Returned to every member of the workspace, not only the owner.
string | null
Name of the workspace owner, or null when the owner has not set one.
string
orgo, or bops for a workspace the Bops app made.
string | null
Set only on a workspace the Bops app made. null otherwise.
string
Your role in the workspace: owner, admin (can edit), or member (Can chat).
object
What your role allows, as four booleans: canView, canWrite, canManageAccess, and canUseAgent. Only the owner has canManageAccess. canUseAgent is true for every role, Can chat included.
array
Computers in the workspace, in no guaranteed order. Ephemeral computers are excluded. Each entry is the stored computer record with credential fields removed, plus the same permissions object. It carries more fields than the example below. Treat any field not documented here as internal and subject to change.
member_count is returned by List workspaces only, not by this endpoint. The workspace object can carry other fields. Treat any field not documented here as internal and subject to change.

Example

Response

Errors

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required

Workspace ID

Response

Workspace details

id
string

Unique workspace identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string

Workspace name

Example:

"production"

user_id
string

Owner user ID

status
string

active for a normal workspace. The product understands active and inactive. Create stores the value as given; update takes only those two.

Example:

"active"

icon_url
string | null

Icon URL for the workspace, or null when none is set.

created_at
string<date-time>
updated_at
string<date-time>
product
enum<string>

orgo, or bops for a workspace the Bops app made.

Available options:
orgo,
bops
bops_ws_id
string | null

Set only on a workspace the Bops app made. null otherwise.

owner_tier
string

Subscription tier of the workspace owner. It sets the hardware ceiling for every computer in the workspace.

Example:

"hacker"

owner_email
string

Email address of the workspace owner. Returned to every member.

role
enum<string>

Your role in the workspace: owner, admin (can edit), or member (Can chat).

Available options:
owner,
admin,
member
permissions
object

What your role in the workspace allows.

member_count
integer

People with access to the workspace, counting the owner. Returned by GET /workspaces only.

desktops
object[]

Computers in the workspace, in no guaranteed order. Ephemeral computers are excluded. Each entry is the stored computer record with credential fields removed, plus permissions. Treat fields not documented here as internal.

owner_name
string | null

Name of the workspace owner, or null when the owner has not set one.