List Syncs

GET

https://app.polytomic.com/api/syncs

GET

/api/syncs

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": "12345678-1234-1234-1234-123456789012",
8         "name": "John Doe",
9         "type": "user"
10       },
11       "encryption_passphrase": "encryption_passphrase",
12       "fields": [
13         {
14           "target": "name",
15           "override_value": "fixed_value",
16           "source": {
17             "field": "id",
18             "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
19           },
20           "sync_mode": "create"
21         }
22       ],
23       "filter_logic": "filter_logic",
24       "filters": [
25         {
26           "function": "Equality",
27           "field": {
28             "field": "id",
29             "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
30           },
31           "field_id": "field1",
32           "label": "A"
33         }
34       ],
35       "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
36       "identity": {
37         "function": "Equality",
38         "source": {
39           "field": "id",
40           "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
41         },
42         "target": "name"
43       },
44       "mode": "create",
45       "model_ids": [
46         "model_ids"
47       ],
48       "name": "Users Sync",
49       "only_enrich_updates": false,
50       "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
51       "override_fields": [
52         {
53           "target": "name",
54           "override_value": "fixed_value",
55           "source": {
56             "field": "id",
57             "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
58           },
59           "sync_mode": "create"
60         }
61       ],
62       "overrides": [
63         {
64           "field": {
65             "field": "id",
66             "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
67           },
68           "field_id": "field1"
69         }
70       ],
71       "policies": [
72         "248df4b7-aa70-47b8-a036-33ac447e668d"
73       ],
74       "schedule": {
75         "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
76       },
77       "skip_initial_backfill": false,
78       "sync_all_records": false,
79       "target": {
80         "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
81         "configuration": {
82           "key": "value"
83         },
84         "create": {
85           "name": "value"
86         },
87         "object": "Users",
88         "search_values": {
89           "name": "value"
90         }
91       },
92       "updated_at": "2024-01-15T09:30:00Z",
93       "updated_by": {
94         "id": "12345678-1234-1234-1234-123456789012",
95         "name": "John Doe",
96         "type": "user"
97       }
98     }
99   ]
100 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

activebooleanOptional

modeenumOptional

target_connection_idstringOptional

Response

datalist of objects

Errors

400

Model Sync List Request Bad Request Error

401

Model Sync List Request Unauthorized Error

404

Model Sync List Request Not Found Error

500

Model Sync List Request Internal Server Error

Authentication

Headers

Query parameters

Response

Errors