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

# List Workspaces

> Returns paginated workspaces with repository associations and pull request states.



## OpenAPI

````yaml /openapi.json get /v1/workspaces
openapi: 3.1.0
info:
  title: Replica API
  version: 2.0.0
  description: >-
    The Replica API allows you to programmatically manage cloud workspaces for
    AI agents. Use this API to manage environments (the org-scoped primitive
    workspaces are created from — including variables, files, skills, MCPs, warm
    hooks, start hooks, and warm pools), create and manage replicas, send
    messages, manage chats, stream events, read connected repositories and
    repository sets, and configure automations.
servers:
  - url: https://api.tryreplicas.com
    description: Production API
security:
  - apiKey: []
tags:
  - name: Environments
    description: >-
      Manage environments — the primitive that workspaces are created from.
      Variables, files, skills, MCPs, warm-hooks, and warm-pools are all scoped
      to an environment. Every organization has a singleton Global environment
      whose values apply to every workspace. Personal environments are scoped to
      the authenticated user and can be standalone or source-backed by a team
      environment.
  - name: Repository
    description: >-
      Read repositories and repository sets connected to your organization.
      Repositories are the underlying GitHub-connection layer; bind them to an
      environment to use them in workspaces.
  - name: Replica
    description: Manage replicas (workspaces) for AI agents
  - name: Terminal
    description: Manage interactive terminal sessions in active workspaces
  - name: Preview
    description: Manage public preview URLs for workspace ports
  - name: Profile
    description: Read and update the authenticated user's profile
  - name: Credentials
    description: >-
      Manage coding-agent credentials for an organization or the authenticated
      user
  - name: Google Search Console
    description: >-
      Read Search Console properties, performance, sitemaps, and URL inspection
      results through a connected Google account
  - name: Slack
    description: Route Slack threads to Replicas workspaces
  - name: Automation
    description: >-
      Create and manage automations that trigger replicas on a schedule or in
      response to events
  - name: Downloads
    description: Download Replicas applications
  - name: Analytics
    description: >-
      Read aggregated activity and usage metrics for your organization: compute
      minutes, workspaces created by source, and pull request throughput over a
      time range.
paths:
  /v1/workspaces:
    get:
      tags:
        - Replica
      summary: List Workspaces
      description: >-
        Returns paginated workspaces with repository associations and pull
        request states.
      operationId: listWorkspaces
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 10
            minimum: 1
        - name: name
          in: query
          description: Filter workspaces by name.
          required: false
          schema:
            type: string
        - name: viewModes
          in: query
          description: Comma-separated workspace views, such as `owned,shared`.
          required: false
          schema:
            type: string
        - name: archived
          in: query
          description: Controls whether archived workspaces are included.
          required: false
          schema:
            type: string
            enum:
              - include
              - exclude
              - only
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkspacesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ListWorkspacesResponse:
      type: object
      properties:
        workspaces:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceListItem'
        workspace_repositories:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceRepository'
        workspace_pull_requests:
          type: array
          items:
            $ref: '#/components/schemas/WorkspacePullRequestState'
        creator_names:
          type: object
          additionalProperties:
            type: string
        creator_avatar_urls:
          type: object
          additionalProperties:
            type: string
            format: uri
        shared_with:
          type: object
          additionalProperties:
            type: array
        viewer_share_ids:
          type: array
          items:
            type: string
            format: uuid
        total:
          type: integer
        page:
          type: integer
        limit:
          type: integer
        totalPages:
          type: integer
      required:
        - workspaces
        - total
        - page
        - limit
        - totalPages
    WorkspaceListItem:
      type: object
      description: A workspace returned by the dashboard workspace list.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - active
            - sleeping
            - archived
            - preparing
            - error
        created_at:
          type: string
          format: date-time
        last_activity_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - id
        - name
        - status
        - created_at
        - last_activity_at
    WorkspaceRepository:
      type: object
      description: A repository associated with a workspace.
      properties:
        id:
          type: string
          format: uuid
        workspace_id:
          type: string
          format: uuid
        provider:
          type: string
          enum:
            - github
            - gitlab
        name:
          type: string
        url:
          type: string
          format: uri
        default_branch:
          type: string
      required:
        - id
        - workspace_id
        - provider
        - name
        - url
        - default_branch
    WorkspacePullRequestState:
      type: object
      description: The latest pull request state associated with a workspace.
      properties:
        workspace_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - open
            - closed
            - merged
      required:
        - workspace_id
        - status
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        details:
          type:
            - string
            - 'null'
          description: Additional error details
      required:
        - error
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        API key authentication. Obtain your API key from the Replicas dashboard
        under Organization → Settings → API Keys.

````