For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Opportunity object
          • GET/opportunities
          • POST/opportunities
          • GET/opportunities/{id}
          • PATCH/opportunities/{id}
          • GET/opportunities/meta/patch/{id}
          • GET/opportunities/meta/post
          • GET/opportunities/remote-field-classes

Get started

  • Overview
  • Introduction
  • Unified API
  • Linked Account
  • Merge Link
  • Use cases

Implementation

  • Sandboxes
  • SDKs
  • API access
  • Syncing data
  • Writing data
  • Data minimization
  • Supplemental data
  • Errors
  • Integration metadata

API reference

  • ATS
  • HRIS
  • Accounting
  • Ticketing
  • CRM
  • File Storage
  • Knowledge Base
  • Chat

Resources

  • Help Center
  • Merge.dev
  • Changelog
© Merge 2026Terms of usePrivacy policy
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsOpportunities

The Opportunity object

The Opportunity Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "name": "string",
7  "description": "string",
8  "amount": 0,
9  "owner": "string",
10  "account": "string",
11  "stage": "string",
12  "status": "OPEN",
13  "last_activity_at": "2023-01-01T00:00:00Z",
14  "close_date": "2023-01-01T00:00:00Z",
15  "remote_created_at": "2023-01-01T00:00:00Z",
16  "opportunity_url": "string",
17  "remote_was_deleted": true,
18  "field_mappings": {
19    "organization_defined_targets": {
20      "string": {}
21    },
22    "linked_account_defined_targets": {
23      "string": {}
24    }
25  },
26  "remote_data": [
27    {
28      "path": "string",
29      "data": {}
30    }
31  ],
32  "remote_fields": [
33    {
34      "remote_field_class": {
35        "id": "string",
36        "display_name": "string",
37        "remote_key_name": "string",
38        "description": "string",
39        "is_custom": true,
40        "is_common_model_field": true,
41        "is_required": true,
42        "field_type": "string",
43        "field_format": "string",
44        "field_choices": [
45          "string"
46        ],
47        "item_schema": {
48          "item_type": "string",
49          "item_format": "string",
50          "item_choices": [
51            "string"
52          ]
53        }
54      },
55      "value": {
56        "string": {}
57      }
58    }
59  ]
60}
Was this page helpful?
Previous

/notes/remote-field-classes

Next

/opportunities

The Opportunity object is used to represent a deal opportunity in a CRM system.

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.
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
remote_fieldslist of objectsOptionalRead-only