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

# List workspaces

> Returns a paginated list of workspaces the caller has access to.



## OpenAPI

````yaml GET /workspaces
openapi: 3.1.0
info:
  title: Scrums.com API
  version: 1.0.0
  description: >-
    The Scrums.com Software Engineering Orchestration Platform (SEOP) REST API.
    Every capability — talent, managed delivery, ODS, infrastructure,
    intelligence, and agents — operates through a Service Line (LIN-*). Base
    URL: https://api.scrums.com/v1
servers:
  - url: https://api.scrums.com/v1
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Service Lines
    description: Manage SEOP Service Lines (LIN-*) across all product types.
  - name: Organizations
    description: Top-level account containers (ORG-*).
  - name: Workspaces
    description: Team workspaces nested within an organization (WS-*).
  - name: AI Agent Gateway
    description: Trigger and monitor AI agent runs (AGT-*, RUN-*).
  - name: Observability & Metrics
    description: Health scores, risk signals, and delivery metrics.
  - name: ODS
    description: On-Demand Solutions scoping and request management.
  - name: Talent Marketplace
    description: Submit and manage vetted talent placement requests.
paths:
  /workspaces:
    get:
      tags:
        - Workspaces
      summary: List all workspaces
      description: Returns a paginated list of workspaces the caller has access to.
      operationId: listWorkspaces
      parameters:
        - name: organization_id
          in: query
          description: Filter by organization ID.
          schema:
            type: string
        - name: status
          in: query
          description: Filter by workspace status.
          schema:
            type: string
            enum:
              - active
              - archived
        - name: cursor
          in: query
          description: Pagination cursor from a previous response.
          schema:
            type: string
        - name: limit
          in: query
          description: Maximum number of results to return (1–100).
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
      responses:
        '200':
          description: Paginated list of workspaces.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Workspace'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
              example:
                data:
                  - id: WS-26-000021
                    organization_id: ORG-26-090500
                    name: Platform Engineering
                    slug: platform-engineering
                    status: active
                    member_count: 12
                    active_service_lines: 3
                    health_score: 87
                    cost_mtd: 34500
                    currency: USD
                    created_at: '2025-11-05T09:00:00Z'
                    updated_at: '2026-04-12T07:30:00Z'
                meta:
                  cursor: null
                  has_more: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Workspace:
      type: object
      properties:
        id:
          type: string
          pattern: ^WS-
          example: WS-26-000021
        organization_id:
          type: string
          example: ORG-26-090500
        name:
          type: string
          example: Platform Engineering
        slug:
          type: string
          example: platform-engineering
        status:
          type: string
          enum:
            - active
            - archived
          example: active
        member_count:
          type: integer
          example: 12
        active_service_lines:
          type: integer
          example: 3
        health_score:
          type: integer
          minimum: 0
          maximum: 100
          example: 87
        cost_mtd:
          type: number
          example: 34500
        currency:
          type: string
          example: USD
        created_at:
          type: string
          format: date-time
          example: '2025-11-05T09:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-04-12T07:30:00Z'
    PaginationMeta:
      type: object
      properties:
        cursor:
          type: string
          example: eyJpZCI6IkxJTi0yNi0wODQ3MjkifQ==
        has_more:
          type: boolean
          example: false
    Error:
      type: object
      required:
        - code
        - message
        - status
      properties:
        code:
          type: string
          example: not_found
        message:
          type: string
          example: The requested resource was not found.
        status:
          type: integer
          example: 404
  responses:
    BadRequest:
      description: The request was malformed or contained invalid parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: invalid_request
            message: workspace_id is required.
            status: 400
    Unauthorized:
      description: Missing or invalid authentication token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: unauthorized
            message: Bearer token is missing or expired.
            status: 401
    Forbidden:
      description: >-
        The authenticated principal does not have permission to perform this
        action.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: forbidden
            message: You do not have access to this resource.
            status: 403
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````