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

# Get the workspace

> The credential's workspace, with seat usage. `seatsUsed` counts active members **and** pending invitations still in date — an expired invitation stops counting on its own.



## OpenAPI

````yaml openapi.json GET /v1/workspace
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `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: Get the workspace
      description: >-
        The credential's workspace, with seat usage. `seatsUsed` counts active
        members **and** pending invitations still in date — an expired
        invitation stops counting on its own.
      operationId: get_workspace
      responses:
        '200':
          description: The 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
                    example: 4
                  seatLimit:
                    type: integer
                    example: 10
        '403':
          description: Insufficient role, wrong credential, or invitations disabled.
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````