Referência da API
Cada endpoint REST que a plataforma expõe, gerado diretamente da especificação da própria API e reconstruído a cada versão.
Navegue por ela na seção Referência da API na barra lateral, agrupada por recurso.
A referência hoje diz quais endpoints existem — método, caminho, agrupamento e a permissão que cada um exige. Ela ainda não documenta corpos de requisição, corpos de resposta ou esquemas de campo, porque a especificação da qual é gerada não os carrega.
Ou seja: é um mapa confiável da superfície da API, e ainda não substitui ler uma resposta real. Para conhecer o formato de um payload hoje, chame o endpoint.
Você também verá identificadores internos como rótulos — EntityTypesController_list
em vez de "Listar tipos de entidade" — pelo mesmo motivo. Ambos se resolvem com o
mesmo trabalho: publicar os esquemas da camada de validação da API na
especificação.
A referência reflete a especificação publicada, que é gerada a partir da API mas não é garantidamente regerada a cada mudança. Se um endpoint aqui não se comportar como descrito — ou se um endpoint que você sabe existir estiver faltando — confie na API em execução e reporte a divergência.
Convenções
| Caminho base | Todo endpoint é versionado sob um prefixo comum |
| Organização | Vem do seu token, nunca da URL |
| Autenticação | Um token bearer emitido pela plataforma, obtido ao entrar pelo seu provedor de identidade. Um token do provedor não é aceito diretamente. |
| Paginação | Parâmetros de página e tamanho; respostas carregam os totais |
| Ordenação | Um parâmetro de ordenação; prefixe um campo com - para inverter |
| Filtragem | Parâmetros de filtro por campo |
Permissões
Quase todo endpoint exige um ou mais códigos de permissão. A falta de um retorna 403 com o código faltante nomeado na resposta, então uma falha diz exatamente o que conceder.
Um pequeno número é deliberadamente público: a sonda de saúde, as rotas de entrada e de retorno, e o endpoint de chaves.
Erros
Erros compartilham um envelope: um código legível por máquina, uma mensagem legível por humanos resolvida no idioma de quem chama, detalhe por campo para falhas de validação, e um identificador de rastro.
Cite o identificador de rastro ao reportar um problema — ele localiza a requisição diretamente. Veja códigos de erro.
Idioma
Envie um cabeçalho de idioma padrão e as mensagens de erro voltam nesse idioma onde houver tradução. Códigos nunca mudam — são identificadores estáveis, não texto de exibição.
Não traduzida
Esta referência é publicada apenas em inglês. Ela documenta caminhos de endpoint, nomes de campos, valores de opção e códigos de erro, todos superfícies do produto que precisam corresponder exatamente ao que a API aceita. Traduzi-los criaria uma referência que discorda do software.
Última verificação no commit d3c2586b (2026-08-03)