Skip to main content
GET
/
workspaces
/
{id}
Get workspace
curl --request GET \
  --url https://www.orgo.ai/api/workspaces/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "production",
  "user_id": "<string>",
  "status": "active",
  "icon_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "desktops": [
    {
      "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "name": "agent-1",
      "project_name": "production",
      "os": "linux",
      "ram": 4,
      "cpu": 1,
      "disk_size_gb": 8,
      "status": "running",
      "url": "https://orgo.ai/workspaces/a3bb189e-8bf9-3888-9912-ace4e6543002",
      "created_at": "2023-11-07T05:31:56Z",
      "instance_id": "a3881618",
      "hostname": "www.orgo.ai",
      "connection_url": "https://www.orgo.ai/desktops/a3881618",
      "vnc_password": "a06db12a8683df96"
    }
  ]
}
Returns a workspace by ID, including its computers (desktops).

​
Path parameters

​
id
string
required
Workspace ID.

​
Response

​
id
string
Workspace identifier.
​
name
string
Workspace name.
​
user_id
string
Owner user ID.
​
status
string
Workspace status.
​
icon_url
string
Icon URL, if set.
​
created_at
string
ISO 8601 timestamp.
​
updated_at
string
ISO 8601 timestamp.
​
desktops
array
Computers in this workspace.

​
Example

curl https://www.orgo.ai/api/workspaces/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer $ORGO_API_KEY"

​
Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "production",
  "user_id": "4d96f9a0-7727-4b63-889a-32544c206d7c",
  "status": "active",
  "icon_url": null,
  "created_at": "2026-04-07T10:30:00Z",
  "updated_at": "2026-04-07T10:30:00Z",
  "desktops": [
    {
      "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "name": "agent-1",
      "os": "linux",
      "ram": 4,
      "cpu": 1,
      "status": "running"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "name": "agent-2",
      "os": "linux",
      "ram": 8,
      "cpu": 2,
      "status": "stopped"
    }
  ]
}

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
enum<string>
Available options:
active,
inactive
Example:

"active"

​
icon_url
string | null

Optional icon URL

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
desktops
object[]