We offer a collection of Opportunity APIs that may appear to overlap with some of your CRM systems. Our APIs, even when returning CRM objects, always include platform-specific data. For example, opportunities returned by our APIs may include engagement-level trends.
How to make a request
Path | Return all opportunities | |
Path | /v0/public/opportunities/{id} | Return opportunity by ID |
Path | /v0/public/opportunities/crm-id/{id} | Return opportunity by crm-id |
Method | GET |
|
Pagination | Yes |
|
Schema
Field | Type | Description |
id | integer | Unique Backstory identifier for the opportunity |
owner_crm_id | integer | Unique CRM identifier for the opportunity owner |
created_by_crm_id | integer | Unique CRM identifier for the user who created the opportunity |
modified_by_crm_id | integer | Unique CRM identifier for the user who modified the opportunity |
type | string | Type of the opportunity |
name | string | Name of the opportunity |
won | boolean | Indicates whether the opportunity is won |
closed | boolean | Indicates whether the opportunity is closed |
active | boolean | Indicates whether the opportunity is active |
amount | float | Amount of the opportunity as stated in CRM |
currency_iso_code | string | ISO code for the stated amount |
forecast_category | string | Forecast category of the opportunity |
close_date | date | Close date of the opportunity |
lead_source | string | Source of the opportunity |
stage_name | string | Stage of the opportunity |
deleted | boolean | Indicates whether the opportunity was deleted |
created_at | timestamp | Created date of the opportunity |
crm_id | string | Unique CRM identifier for the opportunity |
modified_at | timestamp | Modified date of the opportunity |
account_id | integer | Unique Backstory identifier for the account |
account_crm_id | string | Unique CRM identifier for the account |
opportunity_converted_amount | float | Backstory converted the amount based on the ISO code |