List Syncs

GET

Headers

X-Polytomic-VersionstringOptional

Query parameters

activebooleanOptional

modeenumOptional

target_connection_idstringOptional

Response

This endpoint returns an object.

datalist of objectsOptional

Errors

GET

1 curl -G https://app.polytomic.com/api/syncs \
2      -H "Authorization: Bearer <token>" \
3      -d active=true \
4      -d target_connection_id=0b155265-c537-44c9-9359-a3ceb468a4da

200Retrieved

1 {
2   "data": [
3     {
4       "active": true,
5       "created_at": "2024-01-15T09:30:00Z",
6       "created_by": {
7         "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
8       },
9       "fields": [
10         {
11           "target": "name",
12           "override_value": "fixed_value",
13           "source": {
14             "field": "id",
15             "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
16           },
17           "sync_mode": "create"
18         }
19       ],
20       "filter_logic": "filter_logic",
21       "filters": [
22         {
23           "function": "Equality",
24           "field": {
25             "field": "id",
26             "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
27           },
28           "field_id": "field1",
29           "label": "A"
30         }
31       ],
32       "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
33       "identity": {
34         "function": "Equality",
35         "source": {
36           "field": "id",
37           "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
38         },
39         "target": "name"
40       },
41       "mode": "create",
42       "name": "Users Sync",
43       "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
44       "override_fields": [
45         {
46           "target": "name",
47           "override_value": "fixed_value",
48           "source": {
49             "field": "id",
50             "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
51           },
52           "sync_mode": "create"
53         }
54       ],
55       "overrides": [
56         {
57           "field": {
58             "field": "id",
59             "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
60           },
61           "field_id": "field1"
62         }
63       ],
64       "policies": [
65         "248df4b7-aa70-47b8-a036-33ac447e668d"
66       ],
67       "schedule": {
68         "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
69       },
70       "sync_all_records": false,
71       "target": {
72         "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
73         "object": "Users",
74         "configuration": {
75           "key": "value"
76         },
77         "search_values": {
78           "name": "value"
79         }
80       },
81       "updated_at": "2024-01-15T09:30:00Z",
82       "updated_by": {
83         "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
84       }
85     }
86   ]
87 }

Create Sync

Up Next

1	curl -G https://app.polytomic.com/api/syncs \
2	-H "Authorization: Bearer <token>" \
3	-d active=true \
4	-d target_connection_id=0b155265-c537-44c9-9359-a3ceb468a4da

1	{
2	"data": [
3	{
4	"active": true,
5	"created_at": "2024-01-15T09:30:00Z",
6	"created_by": {
7	"id": "248df4b7-aa70-47b8-a036-33ac447e668d"
8	},
9	"fields": [
10	{
11	"target": "name",
12	"override_value": "fixed_value",
13	"source": {
14	"field": "id",
15	"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
16	},
17	"sync_mode": "create"
18	}
19	],
20	"filter_logic": "filter_logic",
21	"filters": [
22	{
23	"function": "Equality",
24	"field": {
25	"field": "id",
26	"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
27	},
28	"field_id": "field1",
29	"label": "A"
30	}
31	],
32	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
33	"identity": {
34	"function": "Equality",
35	"source": {
36	"field": "id",
37	"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
38	},
39	"target": "name"
40	},
41	"mode": "create",
42	"name": "Users Sync",
43	"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
44	"override_fields": [
45	{
46	"target": "name",
47	"override_value": "fixed_value",
48	"source": {
49	"field": "id",
50	"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
51	},
52	"sync_mode": "create"
53	}
54	],
55	"overrides": [
56	{
57	"field": {
58	"field": "id",
59	"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
60	},
61	"field_id": "field1"
62	}
63	],
64	"policies": [
65	"248df4b7-aa70-47b8-a036-33ac447e668d"
66	],
67	"schedule": {
68	"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
69	},
70	"sync_all_records": false,
71	"target": {
72	"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
73	"object": "Users",
74	"configuration": {
75	"key": "value"
76	},
77	"search_values": {
78	"name": "value"
79	}
80	},
81	"updated_at": "2024-01-15T09:30:00Z",
82	"updated_by": {
83	"id": "248df4b7-aa70-47b8-a036-33ac447e668d"
84	}
85	}
86	]
87	}