{"openapi":"3.0.3","info":{"title":"API do PlugueJuris","version":"6c9b40004e24","description":"API pública do PlugueJuris: ações-núcleo da conta jurídica (conta, usuários, grupos e filiais), escopadas por conta.\n\n**Autenticação:** chave da conta no cabeçalho `Authorization: Bearer <chave>` (ou `x-api-key: <chave>`). A chave fica em Conta no painel do PlugueJuris."},"servers":[{"url":"https://pluguejuris.com.br/api/v1","description":"Produção"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authorization: Bearer <chave da conta>"},"apiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"x-api-key: <chave da conta>"}},"schemas":{"Erro":{"type":"object","properties":{"ok":{"type":"boolean","example":false},"codigo":{"type":"string","example":"nao_encontrado"},"erro":{"type":"string","example":"Mensagem de erro."}}}}},"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"tags":[{"name":"Conta"},{"name":"Usuários"},{"name":"Grupos"},{"name":"Filiais"}],"paths":{"/conta":{"get":{"tags":["Conta"],"summary":"Obter a conta","description":"Dados da conta (escritório) da chave: nome, documento, status e o plano atual.","operationId":"obter_conta","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":true}}}}}},"400":{"description":"Requisição inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Chave ausente ou inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Fora do plano","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/usuarios":{"get":{"tags":["Usuários"],"summary":"Listar usuários","description":"Lista os usuários da conta, com o grupo de permissão de cada um.","operationId":"listar_usuarios","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":true}}}}}},"400":{"description":"Requisição inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Chave ausente ou inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Fora do plano","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/usuarios/{id}":{"get":{"tags":["Usuários"],"summary":"Obter um usuário","description":"Dados de um usuário da conta pelo id.","operationId":"obter_usuario","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":true}}}}}},"400":{"description":"Requisição inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Chave ausente ou inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Fora do plano","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]}},"/grupos":{"get":{"tags":["Grupos"],"summary":"Listar grupos","description":"Lista os grupos de permissão da conta e quantos usuários há em cada um.","operationId":"listar_grupos","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":true}}}}}},"400":{"description":"Requisição inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Chave ausente ou inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Fora do plano","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/filiais":{"get":{"tags":["Filiais"],"summary":"Listar filiais","description":"Lista as filiais (unidades) ativas da conta.","operationId":"listar_filiais","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":true}}}}}},"400":{"description":"Requisição inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Chave ausente ou inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Fora do plano","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/filiais/{id}":{"get":{"tags":["Filiais"],"summary":"Obter uma filial","description":"Dados de uma filial da conta pelo id.","operationId":"obter_filial","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":true}}}}}},"400":{"description":"Requisição inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Chave ausente ou inválida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Fora do plano","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}]}}}}