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

# List Spaces

> Retrieve a paginated list of spaces with optional status filtering



## OpenAPI

````yaml api/openapi.json get /api/spaces
openapi: 3.1.0
info:
  version: '0.1'
  title: Orchata API
servers:
  - url: https://api.orchata.ai
    description: Orchata API Server
security:
  - ApiKey: []
paths:
  /api/spaces:
    get:
      tags:
        - Spaces
      summary: List Spaces
      description: Retrieve a paginated list of spaces with optional status filtering
      parameters:
        - schema:
            type: number
            minimum: 1
            default: 1
          required: false
          name: page
          in: query
        - schema:
            type: number
            minimum: 1
            maximum: 100
            default: 20
          required: false
          name: pageSize
          in: query
        - schema:
            type: string
            enum:
              - active
              - archived
              - all
            default: active
          required: false
          name: status
          in: query
        - schema:
            type: string
          required: false
          name: metadata
          in: query
      responses:
        '200':
          description: Successfully retrieved spaces
          content:
            application/json:
              schema:
                type: object
                properties:
                  spaces:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        orgId:
                          type: string
                        name:
                          type: string
                        slug:
                          type: string
                        icon:
                          type: string
                          enum:
                            - folder
                            - book
                            - file-text
                            - database
                            - package
                            - archive
                            - briefcase
                            - inbox
                            - layers
                            - box
                        description:
                          type: string
                        isArchived:
                          type: boolean
                        archivedAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        metadata:
                          $ref: '#/components/schemas/SpaceMetadata'
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - orgId
                        - name
                        - slug
                        - icon
                        - description
                        - isArchived
                        - archivedAt
                        - createdAt
                        - updatedAt
                  total:
                    type: number
                  page:
                    type: number
                  pageSize:
                    type: number
                  totalPages:
                    type: number
                required:
                  - spaces
                  - total
                  - page
                  - pageSize
                  - totalPages
        '401':
          description: Authentication required
      x-codeSamples:
        - lang: typescript
          label: TypeScript SDK
          source: |-
            import { Orchata } from '@orchata-ai/sdk';

            const client = new Orchata({ apiKey: 'oai_your_api_key' });

            const { spaces, total } = await client.spaces.list();
components:
  schemas:
    SpaceMetadata:
      type: object
      additionalProperties: {}
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Oai-Api-Key

````