Obter pessoa

Obtém pessoa pelo ID

GEThttps://api-publica.sunchat.com.br/v1/pessoas/{id}

curl --request GET \
  --url 'https://api-publica.sunchat.com.br/v1/pessoas/{id}' \
  --header 'X-Ambiente: SEU_NUMERO_DE_CONTA' \
  --header 'X-Authorization: X-Chave-Api SUA_CHAVE'

Autenticação

X-Ambientestring (header)obrigatório

Número da sua conta no SunchatPlus. Aceita também `X-Canal` com o ID de um canal, que resolve a conta a partir dele.

X-Authorizationstring (header)obrigatório

Chave de API no formato `X-Chave-Api {chave}`. O prefixo faz parte do valor. A chave fica em Minha conta › Integrações.

Parâmetros de caminho

idstring<uuid>obrigatório

Resposta 200

Idstring<uuid>

TipoPessoaenum<integer>

Valores aceitos: - `1` — PessoaFisica - `2` — PessoaJuridica

Valores: 1, 2

Nomestring | null

NomeFantasiastring | null

CnpjCpfstring | null

Emailstring | null

Codigostring | null

CodigoDeReferenciastring | null

CodigoDeReferenciaAdicionalstring | null

IdClassificaoDaPessoastring<uuid> | null

IdCargoDaPessoastring<uuid> | null

IdVendedorPrincipalstring<uuid> | null

AssinaturaTicketEmHtmlstring | null

ObservacoesEmHtmlstring | null

FusoHorarioenum<integer>

Valores aceitos: - `0` — Brasilia - `1` — SaoPaulo

Valores: 0, 1

IndicadorDeIeenum<integer>

Valores aceitos: - `1` — ContribuinteIcms - `2` — ContribuinteIsento - `9` — NaoContribuinte

Valores: 1, 2, 9

InscricaoEstadualstring | null

DataDeCadastrostring<date-time>

Enderecosobject[] | null

Idstring<uuid>

IdPessoastring<uuid>

CodigoDeReferenciastring | null

Logradourostring | null

Numerostring | null

Complementostring | null

Bairrostring | null

Cepstring | null

NomeMunicipiostring | null

SiglaUfstring | null

Referenciastring | null

Principalboolean

Ativoboolean

Latitudenumber<double> | null

Longitudenumber<double> | null

Tagsstring[] | null

Resposta 404

Not Found

typestring | null

titlestring | null

statusinteger<int32> | null

detailstring | null

instancestring | null