Pessoas

Pesquisar

<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Pessoas</aside>
get/persons

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/persons
  • Auth: HTTP bearer

Query parameters

sortstring

Campo para ordenar os registros

Example:id
fieldsstring

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:id,name,tax_id
filter[id]integer

ID da pessoa.

Example:2
filter[id2]integer

ID por empresa da pessoa.

Example:2
filter[name]string

Nome da pessoa.

Example:carlos%
filter[responsible]string

Filtra por usuários responsáveis.

Example:3,5
filter[type]string

Vínculo com a imobiliária.

Example:owner
filter[access]string

Tipo de acesso à pessoa.

Example:all
filter[active]boolean

Pessoas ativas.

Example:true
filter[origin_id]integer

ID de origem.

Example:29
filter[reference]string

Referência.

Example:R55
filter[gender]string

Sexo.

Example:M
filter[approved]boolean

Pessoas aprovadas.

Example:true
filter[juridical]string

Tipo de pessoa (física, jurídica).

Example:F
filter[tax_id]string

CPF/CNPJ.

Example:57157949008
filter[tag]integer

Tags.

Example:1182
filter[rg]string

RG.

Example:45.461.713-6
filter[rg_emmiter]string

Emissor do RG.

Example:ssp
filter[rg_dispatcher]string

Data de Emissão do RG.

Example:2011-09-08
filter[cnh]string

N° da CNH.

Example:43375783744
filter[nationality]string

Nacionalidade.

Example:Brasileira
filter[naturality]string

Naturalidade.

Example:Rio do Sul
filter[birthplace]string

Local de nascimento.

Example:Rio do Sul
filter[birth_date]string

Data de nascimento.

Example:2011-09-08
filter[marital]string

Estado civil.

Example:married
filter[spouse_id]integer

ID do cônjuge.

Example:5
filter[legal_representative_id]integer

ID do Representante legal.

Example:80
filter[contacted_at]string

Data de contato.

Example:2021-03-22 11:31:00
filter[last_contact_at]string

Última data de contato via Lead.

Example:2021-03-22 11:31:00
filter[father_name]string

Nome do pai.

Example:Rogério
filter[mother_name]string

Nome da mãe.

Example:Maria
filter[occupation_id]integer

ID da profissão.

Example:10
filter[occupation]string

Descrição da profissão.

Example:Corretor imobiliário
filter[employment_link]string

Vínculo empregatício.

Example:EMP
filter[employment_business]string

Nome da empresa de trabalho.

Example:Apresenta.me
filter[employment_time]integer

Tempo de empresa.

Example:6
filter[employment_phone]string

Telefone da empresa.

Example:+55 47 98420-8674
filter[employment_address]string

Endereço da empresa.

Example:Rua José Debieux
filter[income]string

Renda.

Example:1500.00
filter[income_other]string

Outras rendas.

Example:600.00
filter[notes]string

Observações

Example:Entrou em contato pelo Facebook
filter[company_name]string

Razão social.

Example:Empresa Exemplo
filter[state_inscription_type]string

Indicador IE.

Example:immune
filter[state_inscription]string

Inscrição estadual (IE).

Example:361944136227
filter[municipal_inscription]string

Inscrição municipal (IM).

Example:361944136227
filter[login_date]string

Último login.

Example:2021-03-17 15:50:22
filter[login_active]boolean

Login habilitado.

Example:true
filter[login]string

Login.

Example:carlos_oliveira
filter[financial_alert]boolean

Alerta financeiro habilitado.

Example:true
filter[create_building_alert]boolean

Alerta cadastro de imóveis habilitado.

Example:true
include[contacts]string

Retorna os contatos da pessoa.

Example:phone,email
include[contact]string

Retorna o contato principal da pessoa.

Example:phone,email
include[spouse]string

Retorna os dados do cônjuge.

Example:id,name
include[bankAccounts]string

Retorna as contas da pessoa.

Example:id,description
include[bankAccount]string

Retorna a conta principal ativa.

Example:id,description
include[occupation]string

Retorna a profissão da pessoa.

Example:id,name
include[buildings]string

Retorna os dados dos negócios em que a pessoa é cliente.

Example:id,title
include[contractTenant]string

Retorna os contratos em que a pessoa é inquilina.

Example:id,building_id,type
include[contractTenantRent]string

Retorna os contratos em que a pessoa é inquilina de aluguel.

Example:id,building_id
include[contractOwner]string

Retorna os contratos em que a pessoa é proprietária.

Example:id,building_id
include[tickets]string

Retorna os tickets da pessoa.

Example:id,title
include[deals]string

Retorna os dados dos negócios em que a pessoa é cliente.

Example:id,title
include[origin]string

Retorna os dados da origem da pessoa

Example:sint
include[tags]string

Retorna as Tags da pessoa

Example:officiis
include[responsibles]string

Retorna as pessoas que esta pessoa é responsável.

Example:id,name
include[responsibleGroups]string

Retorna os grupos de usuário.

Example:id,name
include[legalRepresentative]string

Retorna o Representante legal.

Example:id,name
include[image]string

Retorna as imagens.

Example:id,file_name
include[files]string

Retorna os arquivos.

Example:id,file_name

Changes

No recorded changes to this operation across all 1 revision of this API.