Skip to main content
GET
List workspace groups

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}$

Query Parameters

page
integer
default:1

Page number (default: 1)

sort
string

Sorting field with optional order suffix (:asc or :desc). Valid sorting fields: id, name, description, created_by, created_at, type, location. Ascending order is used by default if no suffix is provided.

fields
string

Comma-separated list of fields to include in each workspace group element. Selectable fields: id, name, description, organization_id, created_by, created_at, type, filter, location, entra_id_source. The id field is always included.

Maximum string length: 2048
filters
string

Filter workspace groups by one or more criteria. Provide a JSON object with filter conditions. You can filter by: id, name, description, created_by, created_at, type, location, entra_id_source.resource_id, entra_id_source.resource_type, entra_id_source.resource_name. For nested fields like location or entra_id_source, use dot notation (e.g., location.latitude, entra_id_source.resource_type). Use comparison operators (eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between) and combine multiple conditions with logical operators (and, or). Maximum length: 5120 characters. Filter workspace groups using a JSON object. Specify the field to filter, comparison operator, and value. Example: {"field": "name", "op": "eq", "value": "workspace groups 1"}

Maximum string length: 5120
Example:

"{\"field\": \"name\", \"op\": \"eq\", \"value\": \"Grupo de Workspace 1\"}"

per_page
integer
default:100

Number of items per page

Required range: 1 <= x <= 100

Response

Paginated list of workspace groups successfully retrieved. The response includes pagination metadata and an array of workspace group data.

has_next
boolean
required
data
object[]
required