> ## Documentation Index
> Fetch the complete documentation index at: https://browseruse-0aece648-cursor-proxy-indicator-and-text-6cda.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Workspaces

> Get paginated list of workspaces.



## OpenAPI

````yaml cloud/openapi/v3.json get /workspaces
openapi: 3.1.0
info:
  title: Browser Use Public API v3
  summary: Browser Use session-based agent API (v3)
  version: 3.0.0
servers:
  - url: https://api.browser-use.com/api/v3
    description: Production server
security: []
paths:
  /workspaces:
    get:
      tags:
        - Workspaces
      summary: List Workspaces
      description: Get paginated list of workspaces.
      operationId: list_workspaces_workspaces_get
      parameters:
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 10
            title: Pagesize
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Pagenumber
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    WorkspaceListResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/WorkspaceView'
          type: array
          title: Items
          description: List of workspace views for the current page
        totalItems:
          type: integer
          title: Total Items
          description: Total number of items in the list
        pageNumber:
          type: integer
          title: Page Number
          description: Page number
        pageSize:
          type: integer
          title: Page Size
          description: Number of items per page
      type: object
      required:
        - items
        - totalItems
        - pageNumber
        - pageSize
      title: WorkspaceListResponse
      description: Response model for paginated workspace list requests.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WorkspaceView:
      properties:
        id:
          type: string
          format: uuid
          title: ID
          description: Unique identifier for the workspace
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Optional name for the workspace
        createdAt:
          type: string
          format: date-time
          title: Created At
          description: Timestamp when the workspace was created
        updatedAt:
          type: string
          format: date-time
          title: Updated At
          description: Timestamp when the workspace was last updated
      type: object
      required:
        - id
        - createdAt
        - updatedAt
      title: WorkspaceView
      description: View model for a workspace — persistent shared storage across sessions.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-Browser-Use-API-Key

````