Query Parameters - Listar oportunidades

🤓

Fica ligado!

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

/deals?show=123

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

/deals?page=123

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

/deals?hash=abc
/deals?temperature=123
/deals?started_in_stage_id=123
/deals?company_id=123
/deals?status=123
/deals?closed_at_start=aaaa-mm-dd&closed_at_end=aaaa-mm-dd
/deals?updated_at_start=aaaa-mm-dd&updated_at_end=aaaa-mm-dd
/deals?created_at_start=aaaa-mm-dd&created_at_end=aaaa-mm-dd
/deals?probably_closed_at_start=aaaa-mm-dd&probably_closed_at_end=aaaa-mm-dd
/deals?stage_movement_at_start=aaaa-mm-dd&stage_movement_at_end=aaaa-mm-dd
/deals?last_contact_at=aaaa-mm-dd&last_contact_at=aaaa-mm-dd
/deals?deleted=123
/deals?freezed=123
/deals?lost_reason_id=123
/deals?origin_id=123
/deals?owner_id=123
/deals?person_id=123
/deals?pipeline_id=123
/deals?stage_id=123
/deals?title=abc
/deals?value_start=123&value_end=123
/deals?value_mrr_start=123&value_mrr_end=123

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

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

Outra aplicação para este parâmetro é filtrar por oportunidades 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.

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

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

/deals?sort=id&desc=true

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

/deals?with=customFields
/deals?with=owner
/deals?with=users
/deals?with=pipeline
/deals?with=stage
/deals?with=person
/deals?with=tags
/deals?with=proposals
/deals?with=activityStats
/deals?with=activities
/deals?with=company
/deals?with=persons
/deals?with=city
/deals?with=stageHistories
/deals?with=notes
/deals?with=emails
/deals?with=files
/deals?with=calls
/deals?with=lastStageHistory
/deals?with=startedInStage