For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Token-based authentication with required prefix “Bearer”
Path parameters
idstringRequiredformat: "uuid"
Headers
X-Account-TokenstringRequired
Token identifying the end user.
Query parameters
expandlist of enumsOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
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
Allowed values:
Response
idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
namestring or nullOptional
The opportunity's name.
descriptionstring or nullOptional
The opportunity's description.
amountinteger or nullOptional-2147483648-2147483647
The opportunity's amount.
ownerstring or nullOptionalformat: "uuid"
The opportunity's owner.
accountstring or nullOptionalformat: "uuid"
The account of the opportunity.
stagestring or nullOptionalformat: "uuid"
The stage of the opportunity.
statusenum or nullOptional
The opportunity’s status. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=status to receive the integration’s own value instead.
Allowed values:
last_activity_atdatetime or nullOptional
When the opportunity's last activity occurred.
close_datedatetime or nullOptional
When the opportunity was closed.
remote_created_atdatetime or nullOptional
When the third party's opportunity was created.
opportunity_urlstring or nullOptionalformat: "uri"<=2000 characters
The opportunity's URL in the remote system.
remote_was_deletedbooleanOptionalRead-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 nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
