> ## Documentation Index > Fetch the complete documentation index at: https://docs.postclean.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Ver workspace > Retorna o workspace ao qual a chave de API pertence e, em `me`, o que o usuário da chave pode fazer nele. Só administradores usam chaves de API, então `me.is_admin` é `true` e os posts enviados pela API nunca aguardam aprovação. ## OpenAPI ````yaml /openapi.json get /workspace openapi: 3.1.0 info: title: PostClean API version: 2.0.0 description: >- API REST do PostClean. Autentique com uma chave de API do workspace, enviada como token Bearer no cabeçalho `Authorization`. servers: - url: https://post.chatclean.com.br/api description: PostClean security: - bearerAuth: [] tags: - name: Posts description: Criar, ler, atualizar, excluir e pré-visualizar posts. - name: Post notes description: Notas internas de um post, visíveis aos membros do workspace. - name: Approvals description: Aprovar ou rejeitar posts que aguardam aprovação. - name: Recurrence description: Fazer um post se repetir numa frequência. - name: Media and uploads description: Enviar arquivos e anexar mídia aos posts. - name: Social accounts description: Contas sociais conectadas e as opções de cada rede. - name: Channels description: Horários de postagem e fila de um canal. - name: Ideas description: Ideias do quadro Criar. - name: Idea stages description: As colunas (etapas) do quadro de ideias. - name: Analytics description: Métricas do workspace e dos canais. - name: Labels description: Etiquetas para organizar posts e ideias. - name: Signatures description: Textos reutilizáveis para adicionar aos posts. - name: Workspace description: O workspace ao qual a chave de API pertence. - name: API keys description: Chaves de API pessoais deste workspace. - name: Webhooks description: Webhooks de saída e os registros de entrega. - name: Repurposes description: Automações que republicam vídeos postados fora do PostClean. - name: Platform description: Recursos de cada plataforma e tipos de conteúdo. paths: /workspace: get: tags: - Workspace summary: Ver workspace description: >- Retorna o workspace ao qual a chave de API pertence e, em `me`, o que o usuário da chave pode fazer nele. Só administradores usam chaves de API, então `me.is_admin` é `true` e os posts enviados pela API nunca aguardam aprovação. operationId: getWorkspace responses: '200': description: O workspace. content: application/json: schema: $ref: '#/components/schemas/Workspace' example: id: 9a0b1c2d-3e4f-4a5b-8c6d-7e8f9a0b1c2d name: PostClean created_at: '2026-05-04 12:00:00' updated_at: '2026-09-30 08:15:00' me: is_admin: true requires_approval: false publishes_directly: true '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' components: schemas: Workspace: type: object properties: id: type: string format: uuid name: type: string created_at: type: string description: Em UTC, no formato `Y-m-d H:i:s`. examples: - '2026-05-04 12:00:00' updated_at: type: string description: Em UTC, no formato `Y-m-d H:i:s`. examples: - '2026-09-30 08:15:00' me: type: object description: O que o usuário da chave de API pode fazer neste workspace. properties: is_admin: type: boolean requires_approval: type: boolean description: Sempre `false` para administradores. publishes_directly: type: boolean ErrorBody: type: object properties: message: type: string description: Corpo de erro com uma mensagem. RateLimitErrorBody: type: object properties: name: type: string const: rate_limit_exceeded message: type: string examples: - Rate limit exceeded. Please retry after 30 seconds. description: Corpo devolvido quando o limite de requisições é excedido. responses: Unauthorized: description: >- Chave de API ausente, inválida, revogada ou expirada. Corpos possíveis: `Unauthenticated.` (sem chave, ou chave inválida ou revogada), `Token expired.` (passou do `expires_at`), `Token not found.` e `No workspace selected.` (a chave não está mais ligada a um workspace). content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: message: Unauthenticated. PaymentRequired: description: >- A conta do workspace não tem assinatura ativa nem período de teste. Corpo: `{"message": "Active subscription required."}`. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: message: Active subscription required. Forbidden: description: >- A requisição não é permitida. Chaves de API só funcionam para administradores do workspace (o dono da conta ou um membro marcado como administrador); fora isso, toda requisição devolve `Insufficient workspace permissions.`. Outros corpos: `Workspace access denied.` (o usuário da chave saiu do workspace), `Personal access token required.` (foi enviado um token OAuth do MCP) e `This action is unauthorized.` (por exemplo, a nota pertence a outro membro). content: application/json: schema: $ref: '#/components/schemas/ErrorBody' TooManyRequests: description: 'Limite de requisições excedido: 60 por minuto por workspace.' headers: Retry-After: description: Segundos de espera antes de tentar de novo. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorBody' example: name: rate_limit_exceeded message: Rate limit exceeded. Please retry after 30 seconds. securitySchemes: bearerAuth: type: http scheme: bearer description: Chave de API do workspace, criada em Configurações > Chaves de API. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.