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

# Listar seus workspaces

> Os workspaces em que o usuário da chave de conta é membro ATIVO, com o papel dele em cada um, do vínculo mais antigo ao mais novo. Workspaces arquivados ficam de fora. Use um `id` no `x-workspace-id` para agir dentro daquele workspace com a mesma chave de conta.

**Requer uma chave de conta** (`ps_account_`, criada em Perfil → API). Chaves de workspace, de número e tokens OAuth/MCP recebem `403 ACCOUNT_KEY_REQUIRED`. Enviado com `Cache-Control: no-store`.



## OpenAPI

````yaml openapi.pt.json GET /v1/workspaces
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/workspaces:
    get:
      tags:
        - Workspace
      summary: Listar seus workspaces
      description: >-
        Os workspaces em que o usuário da chave de conta é membro ATIVO, com o
        papel dele em cada um, do vínculo mais antigo ao mais novo. Workspaces
        arquivados ficam de fora. Use um `id` no `x-workspace-id` para agir
        dentro daquele workspace com a mesma chave de conta.


        **Requer uma chave de conta** (`ps_account_`, criada em Perfil → API).
        Chaves de workspace, de número e tokens OAuth/MCP recebem `403
        ACCOUNT_KEY_REQUIRED`. Enviado com `Cache-Control: no-store`.
      operationId: get_workspaces
      responses:
        '200':
          description: Seus workspaces
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Id do workspace — o valor do `x-workspace-id`.
                        name:
                          type: string
                        role:
                          type: string
                          enum:
                            - OWNER
                            - ADMIN
                            - AGENT
                            - ANALYST
                          description: O seu papel naquele workspace.
                        plan:
                          type: string
                          description: >-
                            Plano atual (`FREE`, `PAY_AS_YOU_GO`, `ON_DEMAND`,
                            …).
                        createdAt:
                          type: string
                          format: date-time
                        sharedCard:
                          type: object
                          description: >-
                            Se o workspace está vinculado a um cartão
                            compartilhado (de reserva), e a qual workspace de
                            origem.
                          properties:
                            linked:
                              type: boolean
                              description: >-
                                `true` quando o workspace recorre ao cartão de
                                reserva de `sourceWorkspaceId`.
                            sourceWorkspaceId:
                              type:
                                - string
                                - 'null'
                              description: >-
                                O workspace cujo cartão salvo cobre este; `null`
                                quando não está vinculado.
                          required:
                            - linked
                            - sourceWorkspaceId
              example:
                data:
                  - id: cmh2a9z8y0002ws8example1q
                    name: Bakery Downtown
                    role: OWNER
                    plan: PAY_AS_YOU_GO
                    createdAt: '2026-10-28T09:15:00.000Z'
                    sharedCard:
                      linked: true
                      sourceWorkspaceId: cmh2a1b2c0001ws8example7k
          headers:
            Cache-Control:
              schema:
                type: string
              example: no-store
        '401':
          description: Chave de API ausente, inválida ou revogada
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Invalid API key
        '403':
          description: >-
            Não é chave de conta (`ACCOUNT_KEY_REQUIRED`), não é membro ativo do
            workspace (`WORKSPACE_MEMBERSHIP_REQUIRED`) ou papel abaixo de Admin
            (`PERMISSION_DENIED`)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  This endpoint requires an account API key (ps_account_…),
                  created in Profile → API. Workspace keys, number keys and
                  OAuth tokens cannot use it | Este endpoint exige uma API key
                  de conta (ps_account_…), criada em Perfil → API. Chaves de
                  workspace, de número e tokens OAuth não podem usá-lo
                code: ACCOUNT_KEY_REQUIRED
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````

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