🚫 E-mails de relacionamentos

🚫 Atenção: conjunto de dados temporariamente indisponível.

A consulta ao conjunto e-mails de relacionamentos retorna uma listagem de e-mails das entidades que estão relacionadas à pessoa consultada, contendo detalhes como endereço do e-mail, domínio do e-mail, nome de usuário do e-mail, tipo de e-mail, registro fiscal do relacionamento, classe do relacionamento, tipo do relacionamento, indicador de contato principal, ordenação de prioridade de contato e datas em que o contato foi vinculado à pessoa.

Requisição

No corpo da requisição, o campo type deve conter obrigatoriamente o valor persons e datasets deve conter uma matriz que inclua o elemento relationships_emails para que este conjunto de dados seja consultado, conforme o exemplo abaixo:

{
	"type": "persons",
	"key_type": "cpf",
	"key_value": "***********",
	"datasets": [ "relationships_emails" ]
}

Retorno

Caso a consulta seja concluída com sucesso, os dados estarão disponíveis no objeto data.relationships_emails da resposta. Para saber mais sobre cada campo retornado nesta consulta, verifique a especificação do retorno de código 200 contida na seção responses abaixo.

Body Params
string
enum
required

Tipo da busca

Allowed:
string
enum
required

Tipo da chave de busca

Allowed:
string
required

Valor da chave de busca

filters
array of objects

Lista de filtros de busca

filters
datasets
array of strings
enum
required

Lista de conjuntos de dados desejados

datasets*
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json