GET
/api/v1/workspaces Returns all workspaces. Requires super_admin; non-super-admin discovery uses /auth/me.
Operation ID: listWorkspaces
Authentication
Use one of the following authentication options. Permissions and workspace scope still apply. See authentication and access control.
-
Authorization: Bearer YOUR_ACCESS_TOKEN -
X-API-Key: YOUR_API_KEY
Responses
200 List of workspaces
Content type application/json
object
-
workspacesarray of Workspace ↗
401 Unauthorized
Content type application/json
403 Insufficient permission, disabled login, or invalid CSRF
Content type application/json
413 Request body exceeds the configured limit
Content type application/json
426 HTTPS required
Content type application/json
429 Request rate exceeded
Content type application/json
503 Service temporarily unavailable
Content type application/json
OpenAPI operation definition
{
"description": "Returns all workspaces. Requires super_admin; non-super-admin discovery uses /auth/me.",
"operationId": "listWorkspaces",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"workspaces": {
"items": {
"$ref": "#/components/schemas/Workspace"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "List of workspaces"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Insufficient permission, disabled login, or invalid CSRF"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Request body exceeds the configured limit"
},
"426": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "HTTPS required"
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Request rate exceeded"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Service temporarily unavailable"
}
},
"summary": "List workspaces",
"tags": [
"Workspaces"
]
}