/stages

Returns a list of Stage objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

created_afterdatetimeOptional

If provided, will only return objects created after this datetime.

created_beforedatetimeOptional

If provided, will only return objects created before this datetime.

cursorstringOptional

The pagination cursor value.

include_deleted_databooleanOptional

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.

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

modified_afterdatetimeOptional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforedatetimeOptional

If provided, only objects synced by Merge before this date time will be returned.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

remote_idstringOptional

The API provider's ID for the given object.

Response

nextstring or null

previousstring or null

resultslist of objects or null

1	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	response = client.crm.stages.list(
8	cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
9	)
10	for item in response:
11	yield item
12	# alternatively, you can paginate page-by-page
13	for page in response.iter_pages():
14	yield page

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

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration