get
https://api.marketcircle.net/v1/opportunities/
Show the details of an opportunity
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Opportunity Attributes
| Attribute | Type | Description | Attributes |
|---|---|---|---|
self | reference | URL of the Opportunity | Read-only Non-null |
name | string | Name of the Opportunity | Read-Write Nullable |
state | string | The current state of the opportunity. See Opportunity states for valid values. | Read-Write Non-null Default value is "open" |
type | string | An Opportunity Type | Read-Write Nullable |
probability | integer | Likelihood of the winning the opportunity (percentage) | Read-Write Non-null |
forecasted | datetime | Expected closing date of the opportunity. | Read-Write Nullable |
start | datetime | Start date of the opportunity | Read-Write Nullable |
end | datetime | End date of the opportunity | Read-Write Nullable |
details | string | Details of the opportunity | Read-Write Nullable |
priority | integer | Priority of the opportunity. Must be an integer value between 0 (lowest priority) and 10 (highest priority) | Read-Write Non-null |
category | string | Category name | Read-Write Nullable |
keywords | array of string | List of Keywords | Read-Write Nullable |
extra_fields | array of objects | List of different Extra Fields | Read-Write Nullable |
total | integer | Estimate total for the Opportunity. | Read-only Nullable |
contacts | array of contactrole | List of ContactRoles | Read-Write Nullable |
companies | array of companyrole | List of CompanyRoles | Read-Write Nullable |
appointments | array of reference | List of Appointments | Read-Write Nullable |
forms | array of reference | List of Forms | Read-Write Nullable |
groups | array of reference | List of Groups | Read-Write Nullable |
notes | array of reference | List of Notes | Read-Write Nullable |
tasks | array of reference | List of Tasks | Read-Write Nullable |
current_pipeline | reference | Current pipeline reference | Read-only Nullable |
current_pipeline_stage | reference | Current pipeline stage reference | Read-only Nullable |
owner | reference | URL of the User that is responsible for the opportunity | Read-Write Non-null Default value is creator |
creator | reference | URL of the User that created the opportunity | Read-only Non-null |
create_date | datetime | Timestamp from when the opportunity was created | Read-only Non-null |
modify_date | datetime | Timestamp from when the opportunity was last updated | Read-only Non-null |
trashed | boolean | Is the Contact in the trash | Read-only Non-null |
Opportunity states
| State | Description |
|---|---|
"won" | The opportunity was won |
"open" | The opportunity is still active |
"suspended" | The opportunity is still open but not currently being worked on |
"abandoned" | The opportunity was not won due to inactivity |
"lost" | The opportunity was not won |