/stages/{id}

Returns a Stage object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

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).

Response

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

The datetime that this object was created by Merge.

modified_atdatetime or nullRead-only

The datetime that this object was modified by Merge.

namestring or null

The stage's name.

remote_was_deletedboolean or nullRead-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 objects or nullRead-only

1	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	client.crm.stages.retrieve(
8	id="id",
9	)

1	{
2	"id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
3	"remote_id": "19202938",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"name": "Closed Won",
7	"remote_was_deleted": true,
8	"field_mappings": {
9	"organization_defined_targets": {
10	"custom_key": "custom_value"
11	},
12	"linked_account_defined_targets": {
13	"custom_key": "custom_value"
14	}
15	},
16	"remote_data": [
17	{
18	"path": "/stages"
19	}
20	],
21	"remote_fields": [
22	{
23	"remote_field_class": {
24	"id": "string",
25	"display_name": "string",
26	"remote_key_name": "string",
27	"description": "string",
28	"is_custom": true,
29	"is_common_model_field": true,
30	"is_required": true,
31	"field_type": "string",
32	"field_format": "string",
33	"field_choices": [
34	"string"
35	],
36	"item_schema": {
37	"item_type": "string",
38	"item_format": "string",
39	"item_choices": [
40	"string"
41	]
42	}
43	},
44	"value": "string"
45	}
46	]
47	}