Fetch Opportunity

Fetch Opportunity

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Responses

Response body
object
integer
required

Opportunity ID

string | null

Opportunity public ID

string
required

Name

integer
required

Workspace ID

string | null

Sales Pipeline ID

integer
required

Pipeline Stage

integer
required

Primary Contact

number | null

The potential value of this opportunity in the default currency of the workspace

date-time | null

Close date

date-time | null

Added

date-time | null

Updated

string | null

The ID of the Team-Membership to whom the opportunity is assigned.

primary_contact
object
required

Contact

integer
required

Contact ID

string | null

Contact public ID

integer
required

Workspace ID

string | null

Anonymous

string | null

Email address

string | null

First name

string | null

Last name

string | null

Phone number

string | null

The human-readable time zone, usually set dynamically by the app for the contact, for example, during opt-in.
Read more about time zones and how to map them back to the TZ standard in our Time Zones guide..

string
required

UUID

string | null

Unsubscribed

string | null

Last notification email sent

string | null

Facebook URL

string | null

Twitter URL

string | null

Instagram URL

string | null

Linkedin URL

string | null

Website URL

string | null

Date added

string | null

Last updated

array | null

Any valid array, empty or with valid tags will overwrite existing values. To avoid losing existing tags first use the Fetch Contact endpoint, then be sure to include the existing tags in your payload along with any new addition(s)

tags
object | null

A dynamic key-value pair object where both the key and value are strings. Custom attributes are usually added to the contact when they submit forms that contain custom contact attributes. But you can also add them via the API using the modifying endpoints like Create/Update/Upsert Contact.

array of objects | null

Notes

notes
object
integer
required

Note ID

string | null

Note public ID

string
required

Content

integer | null

The ID of the Team-Membership that created the note.
For notes created via the API, this defaults to the ClickFunnels API default User.

date-time | null

Note creation date

date-time | null

Note last updated date

Language
Credentials
URL