Query Parameters - Listar empresas

🤓

Fica ligado!

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

/companies?show=123

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

/companies?page=123

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

/companies?city_id=123
/companies?manager_id=123
/companies?segment_id=123
/companies?name=abc
/companies?starts_with=abc
/companies?cnpj=123
/companies?observation=abc
/companies?website=abc
/companies?company_status=1
/companies?company_situation=1
/companies?status_touch=1
/companies?is_brand=1
/companies?is_supplier=1
/companies?is_client=1
/companies?is_carrier=1
/companies?is_franchise=1
/companies?is_channel=1
/companies?status=1
/companies?external_code=123

Você também pode filtrar por empresas que tenham campos customizados vinculados, utilizando o ID do campo customizado e o valor esperado que o campo customizado deverá conter, conforme informado abaixo.

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

Caso de uso: desejo filtrar por empresas que tenham o campo customizado "Tem filial extrangeira?" vinculado, cujo ID é 29184 e que contenham o valor "Sim" registrado no campo customizado.

/companies?custom_fields[29184]=Sim

Outra aplicação para este parâmetro é filtrar por empresas que tenham campos customizados 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.

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

Possui também o recurso "sort".
Com ele é possível ordenar informações na busca.

/activityTypes?sort=name&desc=true

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

/companies?with=persons
/companies?with=city
/companies?with=deals
/companies?with=deals_involved
/companies?with=cnaes
/companies?with=tags
/companies?with=notes
/companies?with=notes_through_deals
/companies?with=activities
/companies?with=emails
/companies?with=contactEmails
/companies?with=contactPhones
/companies?with=customFields