Skip to main content
SearchVersion: v3New

Search Opportunity

GET/opportunities/search

Search Opportunity

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:opportunities.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version. Send v3.

Available optionsv3
Example:v3

Query Parameters

statusstring

Filter by opportunity status. all means no status filter, the same as leaving status out. (On POST /opportunities/search, all is not special: a status filter with all matches only opportunities stored with that value, so leave the status filter out to get every status.)

Available optionsopenwonlostabandonedall
Example:open
campaignIdstring

Campaign Id

Example:Y2I9XM7aO1hncuSOlc9L
idstring

Opportunity Id

Example:123akv4LFn6C9frZoy3e
orderstring

Sort order by date added: added_desc (default) or added_asc. desc and asc are accepted as aliases.

Available optionsadded_ascadded_descascdesc
Example:added_asc
endDatestring

End date: MM-DD-YYYY (optionally followed by HH:mm:ss) or epoch milliseconds. A date without a time covers the whole day.

Example:11-30-2026
startAfterstring

Cursor timestamp (epoch ms) for pagination.

Example:1628008053263
startAfterIdstring

Start After Id

Example:UIaE1WjAwWKdlyD7osQI
datestring

Start date: MM-DD-YYYY (optionally followed by HH:mm:ss) or epoch milliseconds

Example:11-01-2026
countrystring

Country code (ISO 3166-1 alpha-2) used to read a phone number in q. Not a filter. Defaults to US.

Example:US
pagenumber

Page number, starting at 1. Cannot be combined with startAfter. page * limit cannot exceed 10,000; use startAfter and startAfterId to read further.

Default:1
Example:1
limitnumber

Results per page, up to 100. 0 or absent means 20.

Default:20
Example:20
getTasksboolean

get Tasks in contact

Example:false
getNotesboolean

get Notes in contact

Example:false
getCalendarEventsboolean

get Calender event in contact

Example:false
querystring

Search query (max 75 characters)

Possible values: <= 75 characters

qstringdeprecated

Deprecated: use query. Search query (max 75 characters); ignored when query is sent.

locationIdstringrequired

Location Id

Example:i2SpAtBVHSVea1sL6oah
pipelineIdstring

Pipeline Id

Example:bCkKGpDsyPP4peuKowkG
pipelineStageIdstring

Stage Id

Example:7915dedc-8f18-44d5-8bc3-77c04e994a10
contactIdstring

Contact Id

Example:WFwVrSSjZ2CNHbZThQX2
assignedTostring

Filter by assigned user identifier

Example:082goXVW3lIExEQPOnd3

Response

Successful response

opportunitiesobject[]

List of opportunities matching the search criteria

Example:[]
metaobject

Pagination metadata for the result set

aggregationsobject

Aggregation results keyed by aggregation name