get https://api.chartmogul.com/v1/opportunities/
Retrieves an opportunity object from your ChartMogul account.
Access to the Opportunities endpoints
To use the Opportunities endpoints, you need an API key created by a user with a CRM seat.
Examples
curl -X GET "https://api.chartmogul.com/v1/opportunities/4ee13ca4-e7fe-11ee-fa7f-f303abf41acc" \
-u YOUR_API_KEY: \
-H "Content-Type: application/json"
ChartMogul::Opportunity.retrieve("4ee13ca4-e7fe-11ee-fa7f-f303abf41acc")
ChartMogul.Opportunity.retrieve(config, "4ee13ca4-e7fe-11ee-fa7f-f303abf41acc");
ChartMogul\Opportunity::retrieve("4ee13ca4-e7fe-11ee-fa7f-f303abf41acc");
api.RetrieveOpportunity("4ee13ca4-e7fe-11ee-fa7f-f303abf41acc")
chartmogul.Opportunity.retrieve(config, uuid="4ee13ca4-e7fe-11ee-fa7f-f303abf41acc")
Result Format
{
"uuid": "4ee13ca4-e7fe-11ee-fa7f-f303abf41acc",
"customer_uuid": "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
"owner": "[email protected]",
"pipeline": "New Business",
"pipeline_stage": "Discovery",
"estimated_close_date": "2024-04-21",
"currency": "USD",
"amount_in_cents": 10000,
"type": "recurring",
"forecast_category": "best_case",
"win_likelihood": 40,
"custom": {
"seats": 3,
"marketing_campaign": "Facebook"
},
"created_at": "2024-03-20T09:55:50.156Z",
"updated_at": "2024-03-20T09:55:50.156Z"
}
#<ChartMogul::Opportunity:0x00000001058a8210
@uuid="2f0b0748-e54b-11ee-81c1-5bf123d9787a",
@created_at="2024-03-18T17:15:56.960Z",
@updated_at="2024-03-18T17:15:56.960Z",
@customer_uuid="cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
@owner="[email protected]",
@pipeline="New Business",
@pipeline_stage="Discovery",
@estimated_close_date="2024-03-30",
@currency="USD",
@amount_in_cents=100000,
@type="one-time",
@forecast_category="best_case",
@win_likelihood=30,
@custom={
:seats=>3,
:marketing_campaign=>"Facebook",
}
>
{
uuid: "4ee13ca4-e7fe-11ee-fa7f-f303abf41acc",
customer_uuid: "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
owner: "[email protected]",
pipeline: "New Business",
pipeline_stage: "Discovery",
estimated_close_date: "2024-04-21",
currency: "USD",
amount_in_cents: 10000,
type: "recurring",
forecast_category: "best_case",
win_likelihood: 40,
custom: {
seats: 3,
marketing_campaign: "Facebook"
},
created_at: "2024-03-20T09:55:50.156Z",
updated_at: "2024-03-20T09:55:50.156Z"
}
class ChartMogul\Opportunity (14) {
protected $uuid => string(36) "4ee13ca4-e7fe-11ee-fa7f-f303abf41acc"
protected $customer_uuid => string(40) "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7"
protected $owner => string(17) "[email protected]"
protected $pipeline => string(14) "New Business"
protected $pipeline_stage => string(9) "Discovery"
protected $estimated_close_date => string(10) "2023-12-22"
protected $currency => string(3) "USD"
protected $amount_in_cents => int(100)
protected $type => string(9) "recurring"
protected $forecast_category => string(8) "pipeline"
protected $win_likelihood => int(3)
protected $custom => array(2) {
["seats"] => int(3),
["marketing_campaign"] => string(8) "Facebook"
}
protected $created_at => string(24) "2024-03-13T07:33:28.356Z"
protected $updated_at => string(24) "2024-03-13T07:33:28.356Z"
}
(*chartmogul.Opportunity)(0x140004032b0)({
UUID: (string) (len=36) "4ee13ca4-e7fe-11ee-fa7f-f303abf41acc",
CustomerUUID: (string) (len=40) "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
Owner: (string) (len=17) "[email protected]",
Pipeline: (string) (len=14) "New Business",
PipelineStage: (string) (len=9) "Discovery",
EstimatedCloseDate: (string) (len=10) "2023-12-22",
Currency: (string) (len=3) "USD",
AmountInCents: (int) 100,
Type: (string) (len=9) "recurring",
ForecastCategory: (string) (len=8) "pipeline",
WinLikelihood: (int) 3,
Custom: (map[string]interface {}) (len=1) {
(string) (len=5) "seats": (int) 3,
(string) (len=18) "marketing_campaign": (string) (len=8) "Facebook"
},
CreatedAt: (string) (len=24) "2024-03-13T07:33:28.356Z",
UpdatedAt: (string) (len=24) "2024-03-13T07:33:28.356Z"
})
<Opportunity{
"uuid": "4ee13ca4-e7fe-11ee-fa7f-f303abf41acc",
"customer_uuid": "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
"owner": "[email protected]",
"pipeline": "New Business",
"pipeline_stage": "Discovery",
"estimated_close_date": "2023-12-22",
"currency": "USD",
"amount_in_cents": 100,
"type": "recurring",
"forecast_category": "pipeline",
"win_likelihood": 3,
"custom": {"seats": 3, "marketing_campaign": "Facebook"},
"created_at": "2024-03-13T07:33:28.356Z",
"updated_at": "2024-03-13T07:33:28.356Z"
}>
The response object contains the following data:
| Key | Description |
|---|---|
uuid | The ChartMogul UUID of the opportunity. |
customer_uuid | The ChartMogul UUID of the customer associated with the opportunity. |
owner | The email address of the ChartMogul user with a CRM seat who is the primary salesperson responsible for this opportunity. |
pipeline | The sales pipeline name. |
pipeline_stage | The sales pipeline deal stage name. |
estimated_close_date | The date when the opportunity is expected to close as an ISO 8601-formatted string or, in the case of the Ruby and Python libraries, a datetime object. |
amount_in_cents | The amount in cents (or pence for GBP, etc.) of the expected close value of this opportunity. |
currency | The three-letter currency code for the expected close value, e.g. USD, EUR, or GBP. Read the full list of supported currencies. |
type | The opportunity type, either recurring or one-time. |
forecast_category | The forecast category. One of pipeline, best_case, committed, lost, or won. |
win_likelihood | A percentage (from 0 to 100) representing the likelihood that the opportunity will successfully close. |
custom | A list of key/value pairs of custom attributes assigned to this opportunity. |
created_at | The date and time when the opportunity was created as an ISO 8601-formatted string or, in the case of the Ruby and Python libraries, a datetime object. |
updated_at | The date and time when the opportunity was last updated as an ISO 8601-formatted string or, in the case of the Ruby and Python libraries, a datetime object. |