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

Try it

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

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 or null

List Syncs

Authentication

Headers

Query Parameters

Response

Errors