Search Opportunity

GET 
/opportunities/search

Search Opportunity

Request

Version stringrequired

API Version

Available optionsv3

q string

Search query (max 75 characters)

status string

Filter by opportunity status

Available optionsopenwonlostabandonedall

campaignId string

Campaign Id

id string

Opportunity Id

order string

Sort order for results (e.g. added_asc, added_desc, name_asc, name_desc)

endDate string

End date

startAfter string

Cursor timestamp (epoch ms) for pagination.

startAfterId string

Start After Id

date string

Start date

country string

Filter by country code (ISO 3166-1 alpha-2)

page number

Page number for pagination

Default value:1

limit number

Limit Per Page records count. will allow maximum up to 100 and default will be 20

Default value:20

getTasks boolean

get Tasks in contact

getNotes boolean

get Notes in contact

getCalendarEvents boolean

get Calender event in contact

locationId stringrequired

Location Id

pipelineId string

Pipeline Id

pipelineStageId string

Stage Id

contactId string

Contact Id

assignedTo string

Filter by assigned user identifier

application/json

Successful response

application/json

Schema

Schema

opportunitiesobject[]

List of opportunities matching the search criteria

metaobject

Pagination metadata for the result set

aggregationsobject

Aggregation results keyed by aggregation name

Example (auto)

{
  "opportunities": [],
  "meta": {},
  "aggregations": {}
}