Como ler a referência

A referência é gerada a partir do contrato da própria API a cada publicação deste portal — ela descreve a API como ela está no ar, não como estava quando alguém escreveu um texto.

Organização

As operações estão agrupadas por área, na barra lateral, em Referência da API. Dentro de cada área, ficam agrupadas por recurso. Cada operação mostra:

• método e caminho;
• parâmetros de caminho e de query;
• corpo da requisição, com todos os campos, tipos e valores aceitos;
• respostas possíveis e o formato de cada uma;
• o bloco Autorização, com o módulo e a permissão que a operação exige.

O bloco Autorização

Linha	Significado
Módulo contratado	A empresa precisa ter o módulo, senão 403
Permissão	O colaborador do usuário precisa ter a funcionalidade — leitura para GET, edição para o resto
Papel	Só usuários com o papel listado (por exemplo, o titular da conta, CUSTOMER_OWNER)

Quando a operação diz “qualquer usuário autenticado da empresa”, basta o token.

Nota

Operações sem bloco Autorização e com caminho iniciado por /public/ não pedem token: são as rotas dos componentes públicos, autenticadas por chave ou por token de link.

O que não está aqui

Rotas de administração da plataforma, integrações sob contrato com clientes específicos e módulos verticais de clientes não fazem parte da referência pública.

Ver todas as áreas Lista das áreas com o número de operações de cada uma.