Skip to main content
GET
Ler um contato

Authorizations

Authorization
string
header
required

A chave de API da organização, no cabeçalho Authorization: Bearer <chave>. A chave começa com qx_.

Path Parameters

id
string
required

O id do contato. O id da pessoa começa com per_, e o id da empresa começa com com_.

Response

O contato.

id
string
required

O id do contato. O id da pessoa começa com per_, e o id da empresa começa com com_.

Pattern: ^(per|com)_[1-9][0-9]*$
Example:

"com_12"

type
enum<string>
required

person para a pessoa e company para a empresa.

Available options:
person,
company
name
string | null
required

O nome do contato. O valor é null até a consulta do CPF ou do CNPJ trazer o nome.

Example:

"Importadora Exemplo Ltda"

trade_name
string | null
required

O nome fantasia da empresa. Na pessoa, o valor é null.

Example:

"Exemplo"

email
string | null
required

O e-mail do contato, em minúsculas.

Example:

"fiscal@importadora.com.br"

tax_id
string | null
required

O CPF da pessoa ou o CNPJ da empresa, sem pontuação e com as letras em maiúscula. O valor é null na pessoa que espera a confirmação do CPF.

Example:

"12345678000195"

lookup_status
enum<string>
required

O andamento da consulta do CPF ou do CNPJ. not_enqueued: a consulta não começou. pending: a consulta está em curso. completed: a consulta terminou. failed: a consulta falhou. stale: os dados da consulta estão velhos. needs_review: a pessoa espera a confirmação do CPF.

Available options:
not_enqueued,
pending,
completed,
failed,
stale,
needs_review
discarded
boolean
required

Com true, o contato está arquivado.

origin
enum<string>
required

contact para o contato que a organização criou. shareholder para o sócio que a consulta do CNPJ criou.

Available options:
contact,
shareholder
created_at
string<date-time>
required

A data e a hora da criação, no fuso horário da organização.

Example:

"2026-09-25T10:30:00.000-03:00"