Pessoas

Listar os tipos de vínculo entre pessoas.

GET · API de Integração v2

GET/v2/pessoas/vinculos/tipos

Retorna os tipos ativos, agrupados por categoria e depois por nome. Cada item traz os rótulos dos dois lados — a mesma linha diz "Pai/Mãe" na ficha de um e "Filho(a)" na do outro. Use simetrica para saber se o modal precisa perguntar a direção: quando for false, papelPessoaAtual é obrigatório ao criar o vínculo.

Autenticação

X-API-Key no cabeçalho. Como autenticar

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

Exemplo · HTTP 200
[
  {
    "categoria": "FAMILIAR",
    "codigo": "PARENTAL",
    "id": 3,
    "nome": "Pai/Mãe e Filho",
    "rotuloDestino": "Filho(a)",
    "rotuloOrigem": "Pai/Mãe",
    "simetrica": false
  }
]

Contrato de respostas

200OK

OK

application/json

categoriastring

Agrupamento no seletor

exemplo: FAMILIAR
codigostring

Código estável do tipo

exemplo: PARENTAL
idinteger

ID do tipo, usado como tipoRelacaoId ao criar o vínculo

formato: int64exemplo: 3
nomestring

Nome do tipo, para agrupar no seletor

exemplo: Pai/Mãe e Filho
rotuloDestinostring

Como se chama quem está no lado destino

exemplo: Filho(a)
rotuloOrigemstring

Como se chama quem está no lado origem

exemplo: Pai/Mãe
simetricaboolean

false exige papelPessoaAtual ao criar o vínculo; true dispensa.

exemplo: false
© 2026 Expedit LawtechFeito para conectar.