v1

latestOpenAPI 3.0.02026-08-0645062.8 KB

Deals

Search for deals

Search and filter deals based on various criteria including name, priority, stage, and more

get/deals/search

priority_idinteger

Filter deals by entity priority ID

stage_idinteger

Filter deals by entity stage ID

group_idinteger

Filter deals by group ID

commit_status'Committed' | 'Not Committed'

Filter deals by commitment status

deal_namestring

Search deals by name (partial match)

account_namestring

Search deals by associated account name

ownerstring

Filter deals by owner name (partial match)

Successfully retrieved deals (empty array if no matches found)

entity_type_idinteger

Type ID for deals (fixed value: 3)

idinteger

Unique identifier for the deal

namestring

Deal name

revenuenumber

Deal value/revenue

currencystring

Deal currency

close_datestring date-time

Expected close date

typeinteger

Entity stage ID

priorityinteger

Entity priority ID

group_idinteger

Group identifier

stageinteger

Entity stage ID

ownerstring

Name of the deal owner

is_committedboolean

Deal commitment status

[
  {
    "entity_type_id": 3
  }
]