> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flexxible.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Assigned workspaces

> Retrieve a paginated list of Workspaces belonging to the specified workspace group. Supports pagination, sorting, and filtering via a JSON filter string. The response includes a reduced set of Workspace fields.



## OpenAPI

````yaml /en/api-reference/openapi.en-v1.json get /v1/organizations/{organization_id}/workspace-groups/{workspace_group_id}/workspaces
openapi: 3.0.3
info:
  title: Public Portal API
  version: 1.0.0
  description: Public REST API for portal
servers:
  - url: https://api.staging.flxwvdexternal.com
    description: Staging API server.
security:
  - bearerAuth: []
tags: []
paths:
  /v1/organizations/{organization_id}/workspace-groups/{workspace_group_id}/workspaces:
    get:
      tags:
        - Workspace groups
      summary: Assigned workspaces
      description: >-
        Retrieve a paginated list of Workspaces belonging to the specified
        workspace group. Supports pagination, sorting, and filtering via a JSON
        filter string. The response includes a reduced set of Workspace fields.
      operationId: list workspace groups workspaces
      parameters:
        - name: organization id
          in: path
          required: true
          schema:
            type: string
            maxLength: 24
            pattern: ^[0-9a-f]{24}$
          description: The unique identifier of the organization
          example: 507f1f77bcf86cd799439011
        - name: workspace_group_id
          in: path
          required: true
          schema:
            type: string
            maxLength: 24
            pattern: ^[0-9a-f]{24}$
          description: The unique identifier of the workspace group
          example: 507f1f77bcf86cd799439020
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
          description: 'Page number (default: 1)'
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            default: 100
            maximum: 100
            minimum: 1
          description: 'Items per page (default: 100, max: 100)'
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: >-
            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.
        - name: fields
          in: query
          required: false
          schema:
            type: string
            maxLength: 2048
          description: >-
            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.
          example: name, operative system, total ram
        - name: filters
          in: query
          required: false
          schema:
            type: string
            maxLength: 5120
            description: >-
              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.
          examples:
            simple:
              summary: Filter by Workspace name
              description: Return Workspaces whose name contains the provided text.
              value: '{"field": "name", "op": "contains", "value": "desktop"}'
            complex-and:
              summary: Filter by operating system and RAM
              description: Return Workspaces with Windows and at least 8 GB RAM.
              value: >-
                {"and": [{"field": "operative_system", "op": "contains",
                "value": "Windows"}, {"field": "total_ram", "op": "gte",
                "value": 8192}]}
            complex-or-and:
              summary: Combine OR and AND conditions
              description: Match two subnet prefixes and apply a memory threshold.
              value: >-
                {"and": [{"or": [{"field": "ip_address", "op": "startsWith",
                "value": "172."}, {"field": "ip_address", "op": "startsWith",
                "value": "10."}]}, {"field": "total_ram", "op": "gt", "value":
                4096}]}
      responses:
        '200':
          description: >-
            Paginated list of Workspaces from the workspace group successfully
            retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceGroupWorkspaceListResponseV1'
        '400':
          $ref: '#/components/responses/BadRequest'
          description: Bad Request. Invalid pagination, sorting, or filters.
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: 'Unauthorized: authentication required'
        '404':
          $ref: '#/components/responses/NotFound'
          description: Workspace group not found or does not belong to the organization
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    WorkspaceGroupWorkspaceListResponseV1:
      type: object
      properties:
        has_next:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceGroupWorkspaceItemV1'
      required:
        - has_next
        - data
    WorkspaceGroupWorkspaceItemV1:
      type: object
      description: Workspace element in the Workspace group list (reduced projection).
      properties:
        id:
          type: string
          maxLength: 24
          pattern: ^[0-9a-f]{24}$
        organization_id:
          type: string
          nullable: true
          maxLength: 24
          pattern: ^[0-9a-f]{24}$
        name:
          type: string
          nullable: true
        related_environment:
          type: string
          nullable: true
        operative_system:
          type: string
          nullable: true
        ip_address:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        last_user:
          type: string
          nullable: true
        total_ram:
          type: number
          nullable: true
      required:
        - id
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details:
              type: string
          required:
            - message
            - code
      required:
        - error
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````