Pessoas › Contatos

Pesquisar

<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contato</aside>
get/persons/{person_id}/contacts

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/persons/{person_id}/contacts
  • 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
filter[id]integer

ID do contato.

Example:1
filter[person_id]integer

Pessoa.

Example:123
filter[country_id]integer

País.

Example:1
filter[state_id]integer

Estado.

Example:24
filter[city_id]integer

Cidade.

Example:3
filter[district_id]integer

Bairro.

Example:12
filter[zip_code]integer

CEP.

Example:89160000
filter[street]string

Rua.

Example:%Rua México%
filter[number]string

Número.

Example:1090
filter[complement]string

Complemento de endereço.

Example:Casa
filter[description]string

Descrição.

Example:Marcelo
filter[cellphone]string

Celular.

Example:47988888888
filter[phone]string

Telefone.

Example:4735310000
filter[email]string

E-mail.

Example:mail@example.com
filter[principal]boolean

Contato Principal.

Example:true
filter[financial]boolean

Contato Financeiro.

include[person]string

Retorna os dados da pessoa.

Example:id,name
include[country]string

Retorna os dados do país.

Example:id,abbreviation
include[city]string

Retorna os dados da cidade.

Example:id,name
include[state]string

Retorna os dados do estado.

Example:id,name,abbreviation
include[district]string

Retorna os dados do bairro.

Example:id,name

Changes

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