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

# List Workspaces

> Retrieve all Penbox workspaces that the authenticated user has authorized your application to access.

Retrieve all Penbox workspaces that the authenticated user has authorized your application to access.

## Workspace Slug

The `slug` is a URL-safe, unique identifier for the workspace. It's used in API calls to specify which workspace you want to interact with.

**Slug format:**

* Lowercase letters, numbers, and hyphens
* No spaces or special characters
* Unique across all Penbox workspaces

**Examples:**

* `acme-corp`
* `my-company-123`
* `law-firm-llp`

## Multi-Workspace Support

<Note>
  If a user has authorized your application for multiple workspaces, this endpoint returns all of them. The access token grants access to all authorized workspaces.
</Note>


## OpenAPI

````yaml GET /workspaces
openapi: 3.0.0
info:
  title: Penbox API
  version: '1.0'
  description: >-
    The Penbox API provides programmatic access to Penbox's form management,
    case management, and document processing capabilities. Authenticate using
    Bearer tokens created at https://app.penbox.io/workspace/settings/api
servers:
  - url: https://connect.penbox.io/v1
    description: Production
  - url: https://connect.aiboov.com/v1
    description: Staging
security:
  - BearerAuth: []
paths:
  /workspaces:
    get:
      summary: List Workspaces
      description: >-
        Retrieve all Penbox workspaces that the authenticated user has
        authorized your application to access.
      operationId: list-workspaces
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      total_count:
                        type: integer
                        description: Total number of workspaces
                      total_pages:
                        type: integer
                        description: Total number of pages
                      page_size:
                        type: integer
                        description: Number of items per page
                      current_page:
                        type: integer
                        description: Current page number
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Workspace UUID
                        created_at:
                          type: string
                          format: date-time
                          description: Creation timestamp
                        slug:
                          type: string
                          description: Workspace slug identifier
                        name:
                          type: string
                          description: Workspace name
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: >-
        API token (starts with pnbx_). Create at
        https://app.penbox.io/workspace/settings/api. Include as: Authorization:
        Bearer {token}

````