Skip to main content
GET
Assigned workspaces

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required

The unique identifier of the organization

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
workspace_group_id
string
required

The unique identifier of the workspace group

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Query Parameters

page
integer
default:1

Page number (default: 1)

per_page
integer
default:100

Items per page (default: 100, max: 100)

Required range: 1 <= x <= 100
sort
string

Sort field with optional order suffix (:asc or :desc). Use response property names: id, organization_id, name, related_environment, operative_system, ip_address, type, last_user, total_ram.

fields
string

Comma-separated list of fields to include in each Workspace item. Selectable fields: id, organization_id, name, related_environment, operative_system, ip_address, type, last_user, total_ram. The id field is always included.

Maximum string length: 2048
filters
string

JSON string with filter conditions. Use response property names for fields. Operators: eq, ne, in, nin, gt, gte, lt, lte, contains, startsWith, endsWith, between. Combine with and/or.

Maximum string length: 5120

Response

Paginated list of Workspaces from the workspace group successfully retrieved.

has_next
boolean
required
data
object[]
required