List Bulk Syncs

GET

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

GET

/api/bulk/syncs

1 from polytomic import Polytomic
2 
3 client = Polytomic(
4     version="YOUR_VERSION",
5     token="YOUR_TOKEN",
6 )
7 client.bulk_sync.list(
8     active=True,
9 )

1 {
2   "data": [
3     {
4       "active": true,
5       "automatically_add_new_fields": "all",
6       "automatically_add_new_objects": "all",
7       "concurrency_limit": 50,
8       "created_at": "2024-01-15T09:30:00Z",
9       "created_by": {
10         "id": "12345678-1234-1234-1234-123456789012",
11         "name": "John Doe",
12         "type": "user"
13       },
14       "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
15       "destination_configuration": {
16         "schema": "my_schema"
17       },
18       "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
19       "disable_record_timestamps": false,
20       "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
21       "mode": "snapshot",
22       "name": "My Bulk Sync",
23       "normalize_names": "enabled",
24       "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
25       "policies": [
26         "248df4b7-aa70-47b8-a036-33ac447e668d"
27       ],
28       "resync_concurrency_limit": 10,
29       "schedules": [
30         {
31           "frequency": "weekly",
32           "created_at": "2023-04-25T12:00:00Z",
33           "created_by": {
34             "id": "12345678-1234-1234-1234-123456789012",
35             "name": "John Doe",
36             "type": "user"
37           },
38           "day_of_month": "1",
39           "day_of_week": "monday",
40           "hour": "12",
41           "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
42           "minute": "30",
43           "month": "1",
44           "selective_mode": "nonincrementalFields",
45           "updated_at": "2023-04-25T12:00:00Z",
46           "updated_by": {
47             "id": "12345678-1234-1234-1234-123456789012",
48             "name": "John Doe",
49             "type": "user"
50           }
51         },
52         {
53           "frequency": "continuous",
54           "created_at": "2023-04-25T12:00:00Z",
55           "created_by": {
56             "id": "12345678-1234-1234-1234-123456789012",
57             "name": "John Doe",
58             "type": "user"
59           },
60           "day_of_month": "1",
61           "day_of_week": "monday",
62           "hour": "12",
63           "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
64           "minute": "30",
65           "month": "1",
66           "selective_mode": "incrementalFields",
67           "updated_at": "2023-04-25T12:00:00Z",
68           "updated_by": {
69             "id": "12345678-1234-1234-1234-123456789012",
70             "name": "John Doe",
71             "type": "user"
72           }
73         }
74       ],
75       "source_configuration": {
76         "replication_slot": "slot"
77       },
78       "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
79       "updated_at": "2024-01-15T09:30:00Z",
80       "updated_by": {
81         "id": "12345678-1234-1234-1234-123456789012",
82         "name": "John Doe",
83         "type": "user"
84       }
85     }
86   ]
87 }

Authentication

AuthorizationBearer

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

Query parameters

activebooleanOptional

Response

datalist of objects

Errors

401

Bulk Sync List Request Unauthorized Error

500

Bulk Sync List Request Internal Server Error

Authentication

Headers

Query parameters

Response

Errors