Pessoas

Consultar a ficha da pessoa

GET · API de Integração v2

GET/v2/pessoas/{id}/ficha

Ficha da pessoa

Devolve, numa chamada, tudo que a ficha exibe: identificação, tipo já resolvido por nome, responsáveis e equipes com nome, documentos, endereço, contatos, observações, campos personalizados com rótulo, e os contadores do topo.

É a rota de leitura; para editar, use GET /v2/pessoas/{id}, que devolve o estado editável. As duas existem porque servem telas opostas: o formulário quer ids crus (o select já tem os nomes), a ficha quer rótulo em tudo e não quer o resto.

pessoaJuridica (inscrição estadual, ramo, responsável) vem null quando os três estão vazios — na prática, pessoa física. A condição é o conteúdo, e não natureza, porque no legado existe cadastro de empresa com esses campos preenchidos e a natureza em branco; escondê-los seria perder dado que a ficha atual mostra.

Não existe aqui o campo legado classificacao: use tipoNome para exibir e tipoId para identificar.

responsaveis e equipes listam apenas os que ainda existem no escritório: vínculo apontando para usuário ou equipe removida não tem nome para exibir e fica de fora. O GET /v2/pessoas/{id} continua devolvendo o id cru desses vínculos, para o formulário de edição não apagá-los ao salvar.

O escritório vem do token. Pessoa inexistente, excluída, de outro escritório ou com id não positivo devolve 404.

Autenticação

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

Parâmetros de caminho1

idintegerobrigatório

ID da pessoa.

exemplo: 337155

Respostas4

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 declarado no OpenAPI · application/json

Exemplo · HTTP 200

{
  "id": 337155,
  "nome": "João da Silva",
  "apelido": "João",
  "avatarUrl": null,
  "tipoId": 1,
  "tipoNome": "Cliente",
  "natureza": "FISICA",
  "cpfCnpj": "000.000.000-00",
  "responsaveis": [
    {
      "id": 1649,
      "nome": "Ana Paula Ferreira"
    }
  ],
  "equipes": [
    {
      "id": 406,
      "nome": "Cível"
    }
  ],
  "documentos": {
    "rg": "1234567",
    "orgaoEmissorRg": "SDS/PE",
    "sexo": "Masculino",
    "naturalidade": "Recife",
    "dataNascimento": "1985-04-12",
    "nomeMae": "Maria da Silva",
    "nomePai": "José da Silva",
    "estadoCivil": "Solteiro(a)",
    "profissao": "Engenheiro"
  },
  "pessoaJuridica": null,
  "endereco": {
    "cep": "50000-000",
    "logradouro": "Rua da Aurora",
    "numero": "100",
    "bairro": "Boa Vista",
    "cidade": "Recife",
    "estado": "PE",
    "complemento": null
  },
  "contatos": {
    "telefonePrincipal": "(81) 99999-9999",
    "telefoneSecundario": null,
    "telefone03": null,
    "telefone04": null,
    "email": "joao@exemplo.com",
    "site": null
  },
  "observacoes": {
    "texto": null,
    "tentativasContato": null
  },
  "camposPersonalizados": [
    {
      "campoId": 100,
      "nome": "Origem",
      "tipoEntrada": "select",
      "valores": [
        "Indicação"
      ]
    }
  ],
  "contadores": {
    "processos": 12,
    "audiencias": 3
  }
}

Contrato de respostas

200Ficha da pessoa.

Ficha da pessoa.

application/json

apelidostring

Apelido ou nome curto

exemplo: João

avatarUrlstring

URL do avatar

camposPersonalizadosCampoPersonalizadoResponse[]

Campos personalizados gravados, com rótulo e tipo de entrada

Ver propriedades

campoIdinteger

ID da definição do campo personalizado

formato: int64exemplo: 12

valoresstring[]

Valores gravados para o campo

exemplo: ["Opção A"]

contadoresContadoresResponse

Ver propriedades

audienciasinteger

Audiências desses processos

formato: int64exemplo: 3

processosinteger

Processos em que a pessoa aparece, em qualquer papel

formato: int64exemplo: 12

contatosContatosResponse

Ver propriedades

emailstring

E-mail

exemplo: joao@exemplo.com

facebookstring

Perfil do Facebook

instagramstring

Perfil do Instagram

linkedinstring

Perfil do LinkedIn

sitestring

Site

telefone03string

Terceiro telefone

telefonePrincipalstring

Telefone principal

exemplo: (81) 99999-9999

telefoneSecundariostring

Telefone secundário

cpfCnpjstring

CPF ou CNPJ como gravado

exemplo: 000.000.000-00

documentosDocumentosResponse

Ver propriedades

cidstring

CID

ctpsstring

CTPS

dataEmissaoRgstring

Data de emissão do RG

dataNascimentostring

Data de nascimento

exemplo: 1990-01-31

estadoCivilstring

Estado civil

nacionalidadestring

Nacionalidade

naturalidadestring

Naturalidade

nomeMaestring

Nome da mãe

nomePaistring

Nome do pai

orgaoEmissorRgstring

Órgão emissor do RG

pisstring

PIS

profissaostring

Profissão

rgstring

sexostring

Sexo

enderecoEnderecoResponse

Ver propriedades

bairrostring

Bairro

cepstring

CEP

exemplo: 50000-000

cidadestring

Cidade

complementostring

Complemento

estadostring

exemplo: PE

logradourostring

Logradouro

numerostring

Número

equipesVinculadoResponse[]

Equipes responsáveis pela pessoa, com nome

Ver propriedades

idinteger

formato: int64exemplo: 1649

nomestring

Nome exibido

exemplo: Ana Paula Ferreira

idinteger

ID da pessoa

formato: int64exemplo: 337155

naturezastring

Natureza da pessoa

valores: FISICA · JURIDICAexemplo: FISICA

nomestring

Nome

exemplo: João da Silva

observacoesObservacoesResponse

Ver propriedades

tentativasContatostring

Tentativas de contato registradas

textostring

Observações livres

pessoaJuridicaPessoaJuridicaResponse

Ver propriedades

inscricaoEstadualstring

Inscrição estadual

ramostring

Ramo de atividade

responsavelstring

Responsável pela empresa

responsaveisVinculadoResponse[]

Usuários responsáveis pela pessoa, com nome

Ver propriedades

idinteger

formato: int64exemplo: 1649

nomestring

Nome exibido

exemplo: Ana Paula Ferreira

tipoIdinteger

ID do tipo no catálogo (GET /v2/pessoas/tipos)

formato: int64exemplo: 1

tipoNomestring

Nome do tipo, para exibir

exemplo: Cliente

400ID não numérico (falha de conversão do path).

ID não numérico (falha de conversão do path).

O contrato não declara um corpo para esta resposta.

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 — inclui excluída, id não positivo e pessoa de outro escritório.

Pessoa não encontrada — inclui excluída, id não positivo e pessoa de outro escritório.

O contrato não declara um corpo para esta resposta.

curl --request GET \
  --url 'https://api.expedit.com.br/v2/pessoas/337155/ficha' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY'

Requisição e resposta

As chamadas são enviadas diretamente à API. O domínio deste portal precisa estar autorizado no CORS.

A resposta aparecerá aquiPreencha os campos e envie a requisição para consultar o retorno da API.

Explorar exemplos de resposta

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 declarado no OpenAPI · application/json

Exemplo · HTTP 200

{
  "id": 337155,
  "nome": "João da Silva",
  "apelido": "João",
  "avatarUrl": null,
  "tipoId": 1,
  "tipoNome": "Cliente",
  "natureza": "FISICA",
  "cpfCnpj": "000.000.000-00",
  "responsaveis": [
    {
      "id": 1649,
      "nome": "Ana Paula Ferreira"
    }
  ],
  "equipes": [
    {
      "id": 406,
      "nome": "Cível"
    }
  ],
  "documentos": {
    "rg": "1234567",
    "orgaoEmissorRg": "SDS/PE",
    "sexo": "Masculino",
    "naturalidade": "Recife",
    "dataNascimento": "1985-04-12",
    "nomeMae": "Maria da Silva",
    "nomePai": "José da Silva",
    "estadoCivil": "Solteiro(a)",
    "profissao": "Engenheiro"
  },
  "pessoaJuridica": null,
  "endereco": {
    "cep": "50000-000",
    "logradouro": "Rua da Aurora",
    "numero": "100",
    "bairro": "Boa Vista",
    "cidade": "Recife",
    "estado": "PE",
    "complemento": null
  },
  "contatos": {
    "telefonePrincipal": "(81) 99999-9999",
    "telefoneSecundario": null,
    "telefone03": null,
    "telefone04": null,
    "email": "joao@exemplo.com",
    "site": null
  },
  "observacoes": {
    "texto": null,
    "tentativasContato": null
  },
  "camposPersonalizados": [
    {
      "campoId": 100,
      "nome": "Origem",
      "tipoEntrada": "select",
      "valores": [
        "Indicação"
      ]
    }
  ],
  "contadores": {
    "processos": 12,
    "audiencias": 3
  }
}

Exemplos e campos gerados do contrato OpenAPI. Revise os valores antes de integrar.