> ## 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.

# Ler o workspace

> Dados do workspace da credencial. Os membros são ilimitados em todos os planos: `seatLimit` é sempre `null`, e `seatsUsed` (membros ativos **e** convites pendentes ainda no prazo) é só informativo.



## OpenAPI

````yaml openapi.pt.json GET /v1/workspace
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/workspace:
    get:
      tags:
        - Workspace
      summary: Ler o workspace
      description: >-
        Dados do workspace da credencial. Os membros são ilimitados em todos os
        planos: `seatLimit` é sempre `null`, e `seatsUsed` (membros ativos **e**
        convites pendentes ainda no prazo) é só informativo.
      operationId: get_workspace
      responses:
        '200':
          description: O workspace
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: tn_1a2b
                  name:
                    type: string
                    example: Acme
                  plan:
                    type: string
                    example: PREMIUM
                  seatsUsed:
                    type: integer
                    description: >-
                      Contagem informativa de membros ativos mais convites
                      pendentes ainda no prazo. Nunca bloqueia um convite.
                    example: 4
                  seatLimit:
                    type:
                      - integer
                      - 'null'
                    description: >-
                      Sempre `null`: os membros são ilimitados em todos os
                      planos. Mantido na resposta por compatibilidade.
                    example: null
        '403':
          description: Papel insuficiente, credencial errada ou convites desabilitados.
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.