/opportunities/{id}

Returns an Opportunity object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
namestring or null
The opportunity's name.
descriptionstring or null
The opportunity's description.
amountinteger or null-2147483648-2147483647
The opportunity's amount.
ownerstring or nullformat: "uuid"
The opportunity's owner.
accountstring or nullformat: "uuid"
The account of the opportunity.
stagestring or nullformat: "uuid"
The stage of the opportunity.
statusenum or null
The opportunity's status. * `OPEN` - OPEN * `WON` - WON * `LOST` - LOST
Allowed values:
last_activity_atdatetime or null
When the opportunity's last activity occurred.
close_datedatetime or null
When the opportunity was closed.
remote_created_atdatetime or null
When the third party's opportunity was created.
remote_was_deletedbooleanRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only
remote_fieldslist of objectsRead-only

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information