Skip to main content
GET
Search Opportunity

Authorizations

Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Query Parameters

q
string
Example:

"john@deo.com"

location_id
string
required

Location Id

Example:

"i2SpAtBVHSVea1sL6oah"

pipeline_id
string

Pipeline Id

Example:

"bCkKGpDsyPP4peuKowkG"

pipeline_stage_id
string

stage Id

Example:

"7915dedc-8f18-44d5-8bc3-77c04e994a10"

contact_id
string

Contact Id

Example:

"WFwVrSSjZ2CNHbZThQX2"

status
enum<string>
Available options:
open,
won,
lost,
abandoned,
all
assigned_to
string
Example:

"082goXVW3lIExEQPOnd3"

campaignId
string

Campaign Id

Example:

"Y2I9XM7aO1hncuSOlc9L"

id
string

Opportunity Id

Example:

"123akv4LFn6C9frZoy3e"

order
string
Example:

"added_asc"

endDate
string

End date

Example:

"mm-dd-yyyy"

startAfter
string

Start After

Example:

"1628008053263"

startAfterId
string

Start After Id

Example:

"UIaE1WjAwWKdlyD7osQI"

date
string

Start date

Example:

"mm-dd-yyyy"

country
string
Example:

"US"

page
number
default:1
limit
number
default:20

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

getTasks
boolean

get Tasks in contact

Example:

false

getNotes
boolean

get Notes in contact

Example:

false

getCalendarEvents
boolean

get Calender event in contact

Example:

false

Response

Successful response

opportunities
object[]
meta
object
aggregations
object
Last modified on March 8, 2026