> ## 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 as chaves do workspace

> As chaves com escopo de tenant do workspace — a principal e as `ps_workspace_` com nome —, mascaradas, nunca a chave bruta. Proprietário ou Admin naquele workspace (`apikeys:read`). Quem não é membro, ou um workspace que não existe ou está arquivado, recebe o mesmo `403 WORKSPACE_MEMBERSHIP_REQUIRED`. As chaves de número ficam em `GET /v1/api-keys`.

**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/{workspaceId}/api-keys
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/{workspaceId}/api-keys:
    get:
      tags:
        - Workspace
      summary: Listar as chaves do workspace
      description: >-
        As chaves com escopo de tenant do workspace — a principal e as
        `ps_workspace_` com nome —, mascaradas, nunca a chave bruta.
        Proprietário ou Admin naquele workspace (`apikeys:read`). Quem não é
        membro, ou um workspace que não existe ou está arquivado, recebe o mesmo
        `403 WORKSPACE_MEMBERSHIP_REQUIRED`. As chaves de número ficam em `GET
        /v1/api-keys`.


        **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_api_keys
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
          description: Id do workspace, obtido em `GET /v1/workspaces`.
          example: cmh2a9z8y0002ws8example1q
      responses:
        '200':
          description: As chaves
          content:
            application/json:
              example:
                data:
                  - id: cmh2aa0010003ak8example4d
                    name: Workspace API Key
                    prefix: ps_workspace_
                    last4: 3b5d
                    isPrimary: true
                    createdAt: '2026-10-28T09:15:00.000Z'
                    lastUsedAt: '2026-10-28T09:20:11.000Z'
                  - id: cmh2ab7770004ak8example9m
                    name: Billing integration
                    prefix: ps_workspace_
                    last4: a1c0
                    isPrimary: false
                    createdAt: '2026-10-28T09:15:00.000Z'
                    lastUsedAt: null
          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.