Listar os relacionamentos de uma pessoa.
GET · API de Integração v2
/v2/pessoas/{id}/vinculosCada item traz a outra pessoa e como ela se chama no vínculo: na ficha do pai sai Maria — Filho(a), e na da filha, Pedro — Pai/Mãe. Agrupado por categoria e nome.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de caminho1
idintegerobrigatórioID da pessoa.
Respostas3
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
{
"categoria": "FAMILIAR",
"dataFim": "2026-01-30",
"dataInicio": "2020-03-15",
"id": 44,
"observacao": "string",
"pessoaId": 20,
"pessoaNome": "Maria da Silva",
"relacao": "Filho(a)",
"simetrica": false,
"tipoCodigo": "PARENTAL",
"tipoNome": "Pai/Mãe e Filho",
"tipoRelacaoId": 3
}Contrato de respostas
200Relacionamentos da pessoa.
Relacionamentos da pessoa.
application/json
categoriastringAgrupamento na ficha
dataFimstringFim da vigência, quando o vínculo terminou
dataIniciostringInício da vigência
idintegerID do vínculo, para editar ou remover
observacaostringObservação livre
pessoaIdintegerID da outra pessoa
pessoaNomestringNome da outra pessoa
relacaostringComo a outra pessoa se chama neste vínculo
simetricabooleantrue quando os dois lados têm o mesmo papel
tipoCodigostringCódigo estável do tipo
tipoNomestringNome do tipo
tipoRelacaoIdintegerID do tipo
401Não autenticado (token ausente/inválido).
Não autenticado (token ausente/inválido).
O contrato não declara um corpo para esta resposta.
404Pessoa não encontrada neste escritório.
Pessoa não encontrada neste escritório.
O contrato não declara um corpo para esta resposta.