Pessoas
Listar tipos de pessoa visíveis ao escritório.
GET · API de Integração v2
GET
/v2/pessoas/tiposRetorna os tipos globais mais os do escritório autenticado, globais primeiro e depois por nome — a ordem em que a UI agrupa "Tipos padrão" / "Tipos do escritório".
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de consulta1
apenasAtivosbooleanEsconde os desativados (default true).
padrão: true
Respostas1
Exemplos ilustrativos · nenhuma requisição é enviada
200 · Sucesso
- Quando acontece
- A operação foi concluída.
- Como tratar
- Leia os dados retornados; em listagens, confira também a paginação.
Exemplo ilustrativo gerado do schema · application/json
[
{
"ativo": true,
"global": false,
"id": 12,
"nome": "Fornecedor"
}
]Contrato de respostas
200OK
OK
application/json
ativobooleanfalse para tipo desativado: some das novas seleções, mas segue válido em quem já o usa.
exemplo: true
globalbooleantrue para tipo padrão do sistema — visível a todos e somente leitura.
exemplo: false
idintegerID do tipo, usado como tipoId no cadastro de pessoa.
formato: int64exemplo: 12
nomestringNome exibido.
exemplo: Fornecedor
