Workspace

Method	Path	Description
GET	`/api/v1/workspaces`	List user's workspaces
GET	`/api/v1/workspaces/{slug}`	Get workspace by ID

List user's workspaces

GET /api/v1/workspaces

Retrieve all workspaces owned by the authenticated user

Responses

Status	Description
`200`	Workspaces retrieved successfully
`401`	Authentication required

Example Response

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "slug": "string",
      "description": "string",
      "ownerId": "550e8400-e29b-41d4-a716-446655440000",
      "provisioned": true,
      "engineVersion": "string",
      "createdAt": "2025-03-28T14:22:03Z",
      "updatedAt": "2025-03-28T14:22:03Z"
    }
  ]
}

Example

curl -X GET "https://poliglot.io/api/v1/workspaces" \
  -H "Authorization: Bearer <your-token>"

Get workspace by ID

GET /api/v1/workspaces/{slug}

Retrieve a workspace by its ID

Path Parameters

Name	Required	Description
`slug`	Yes	Workspace Slug

Responses

Status	Description
`200`	Workspace retrieved successfully
`404`	Workspace not found

Response Shape

Field	Type	Description
`id`	`string (uuid)`
`slug`	`string`
`description`	`string`
`ownerId`	`string (uuid)`
`provisioned`	`boolean`
`engineVersion`	`string`
`createdAt`	`string (date-time)`
`updatedAt`	`string (date-time)`

Example Response

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "slug": "string",
    "description": "string",
    "ownerId": "550e8400-e29b-41d4-a716-446655440000",
    "provisioned": true,
    "engineVersion": "string",
    "createdAt": "2025-03-28T14:22:03Z",
    "updatedAt": "2025-03-28T14:22:03Z"
  }
}

Example

curl -X GET "https://poliglot.io/api/v1/workspaces/<slug>" \
  -H "Authorization: Bearer <your-token>"

On this page