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 Stage object
          • GET/stages
          • GET/stages/{id}
          • GET/stages/remote-field-classes
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsStages

The Stage object

The Stage 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  "remote_was_deleted": true,
8  "field_mappings": {},
9  "remote_data": [
10    {
11      "path": "string",
12      "data": {}
13    }
14  ],
15  "remote_fields": [
16    {
17      "remote_field_class": {
18        "id": "string",
19        "display_name": "string",
20        "remote_key_name": "string",
21        "description": "string",
22        "is_custom": true,
23        "is_common_model_field": true,
24        "is_required": true,
25        "field_type": "string",
26        "field_format": "string",
27        "field_choices": [
28          "string"
29        ],
30        "item_schema": {
31          "item_type": "string",
32          "item_format": "string",
33          "item_choices": [
34            "string"
35          ]
36        }
37      },
38      "value": {
39        "string": {}
40      }
41    }
42  ]
43}
Was this page helpful?
Previous

/opportunities/remote-field-classes

Next

/stages

Built with

The Stage object is used to represent the stage of an opportunity.

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 stage's name.
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