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

# List workspaces



## OpenAPI

````yaml https://raw.githubusercontent.com/PaloAltoNetworks/openapi/refs/heads/main/openapi.yaml get /workspaces
openapi: 3.0.0
info:
  title: Prisma AIRS AI Gateway API
  version: 3.0.0
  description: ''
servers:
  - url: https://aigw.portkey.ai/v1
    description: Managed
  - url: https://self-hosted-gateway-url.example.com/v1
    description: Self-hosted -- replace with your own gateway host
security:
  - Authorization: []
tags:
  - name: Assistants
    description: ''
  - name: Audio
    description: ''
  - name: Batch
    description: ''
  - name: Chat
    description: ''
  - name: Completions
    description: ''
  - name: Decisions
    description: ''
  - name: Embeddings
    description: ''
  - name: Files
    description: ''
  - name: Fine-Tuning
    description: ''
  - name: Images
    description: ''
  - name: Messages
    description: ''
  - name: Model Pricing
    description: ''
  - name: Models
    description: ''
  - name: Moderations
    description: ''
  - name: OCR
    description: ''
  - name: Realtime
    description: ''
  - name: Rerank
    description: ''
  - name: Responses
    description: ''
  - name: Vector Stores
    description: ''
  - name: Configs
    description: ''
  - name: Guardrails
    description: ''
  - name: Integrations
    description: ''
  - name: Integrations > Models
    description: ''
  - name: Integrations > Workspaces
    description: ''
  - name: Providers
    description: ''
  - name: Secret References
    description: ''
  - name: MCP Integrations
    description: ''
  - name: MCP Integrations > Capabilities
    description: ''
  - name: MCP Integrations > Metadata
    description: ''
  - name: MCP Integrations > Workspaces
    description: ''
  - name: MCP Servers
    description: ''
  - name: MCP Servers > Capabilities
    description: ''
  - name: MCP Servers > Connections
    description: ''
  - name: MCP Servers > User Access
    description: ''
  - name: API Keys
    description: ''
  - name: Access Policies
    description: ''
  - name: Deployments
    description: ''
  - name: Egress Allowlist
    description: ''
  - name: Org Guardrails
    description: ''
  - name: Rate Limit Policies
    description: ''
  - name: Usage Limit Policies
    description: ''
  - name: Workspaces
    description: ''
  - name: Analytics > Graphs
    description: ''
  - name: Analytics > Groups
    description: ''
  - name: Analytics > Summary
    description: ''
  - name: Feedback
    description: ''
  - name: Logs
    description: ''
paths:
  /workspaces:
    servers:
      - url: https://api.sase.paloaltonetworks.com/airs/workspace/v1
        description: Managed
    get:
      tags:
        - Workspaces
      operationId: listWorkspaces
      parameters:
        - $ref: '#/components/parameters/WorkspaceLimit'
        - $ref: '#/components/parameters/WorkspaceOffset'
        - name: name
          in: query
          required: false
          schema:
            type: string
        - name: exact_name
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkspacesResponse'
        '400':
          $ref: '#/components/responses/WorkspaceBadRequest'
components:
  parameters:
    WorkspaceLimit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    WorkspaceOffset:
      name: offset
      in: query
      required: false
      schema:
        type: integer
        minimum: 0
        default: 0
  schemas:
    ListWorkspacesResponse:
      type: object
      required:
        - workspaces
        - total_count
        - limit
        - offset
      properties:
        workspaces:
          type: array
          items:
            $ref: '#/components/schemas/Workspace'
        total_count:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
    Workspace:
      type: object
      required:
        - id
        - name
        - description
        - scope_name
        - is_default
        - status
        - tsg_id
        - created_at
        - updated_at
        - created_by
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          maxLength: 500
        scope_name:
          type: string
        is_default:
          type: boolean
        status:
          $ref: '#/components/schemas/WorkspaceStatus'
        tsg_id:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          nullable: true
        created_by:
          type: string
    WorkspaceError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              $ref: '#/components/schemas/WorkspaceErrorCode'
            message:
              type: string
            details:
              type: array
              items:
                type: object
    WorkspaceStatus:
      type: string
      enum:
        - pending
        - active
        - broken
        - failed
        - deleting
    WorkspaceErrorCode:
      type: string
      enum:
        - VALIDATION_ERROR
        - DEFAULT_WORKSPACE
        - NOT_FOUND
        - CONFLICT
        - INTERNAL_ERROR
  responses:
    WorkspaceBadRequest:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WorkspaceError'
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.