Query Parameters - Listar pessoas

🤓

Fica ligado!

Esse endpoint possui o recurso "show".
Com ele é possível trazer o número de itens na página de resultados.

/persons?show=123

Possui também o recurso "page".
Com ele é possível trazer o número da página.

/persons?page=123

Possui também o recurso "filter".
Com ele é possível utilizar atributos do objeto como parâmetros para refinar a busca.

/persons?id=123
/persons?company_id=123
/persons?city_id=123
/persons?owner_id=123
/persons?manager_id=123
/persons?cpf=123
/persons?name=abc
/persons?job_title=abc
/persons?observation=abc
/persons?customer_at=123
/persons?external_code=123
/persons?status=1
/persons?created_at_start=aaaa-mm-dd&created_at_end=aaaa-mm-dd
/persons?updated_at_start=aaaa-mm-dd&updated_at_end=aaaa-mm-dd=123

Também é possível filtrar pessoas que tenham campos customizados específicos vinculados, utilizando o ID do campo customizado e o valor esperado que o campo customizado deverá conter, conforme informado abaixo:

/persons?custom_fields[customField_id]={valor} //para um único campo customizado
/persons?custom_fields[customField_id]={valor}&custom_fields[customField_id]={valor} //para múltiplos campos customizados

Outra aplicação para este parâmetro é filtrar pessoas que tenham campos customizados específicos vinculados e que não tenham um valor específico esperado, utilizando o ID do campo customizado e o valor que o campo customizado não deverá conter.

/persons?custom_fields[customField_id_NOT]={valor} //para um único campo customizado
/persons?custom_fields[customField_id_NOT]&custom_fields[customField_id_NOT]={valor} //para múltiplos campos customizados

Esse endpoint também possui o recurso "sort".

/persons?sort=name&desc=true

E também o recurso "with".
Com ele é possível trazer objetos relacionados ao registro que está sendo buscado.

/persons?with='manager',
/persons?with='owner',
/persons?with='tags',
/persons?with='deals',
/persons?with='deals_involved',
/persons?with='activities',
/persons?with='emails',
/persons?with='microregion',
/persons?with='city',
/persons?with='company',
/persons?with='contactEmails',
/persons?with='contactPhones',
/persons?with='customFields',
/persons?with='files',
/persons?with='filesThroughDeals',
/persons?with='dataLegalOrigin'