Get Bulk Sync

GET

Path parameters

idstringRequired

Headers

X-Polytomic-VersionstringOptional

Query parameters

refresh_schemasbooleanOptional

Response

This endpoint returns an object.

dataobjectOptional

Errors

GET

1 curl -G https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \
2      -H "Authorization: Bearer <token>" \
3      -d refresh_schemas=true

200Retrieved

1 {
2   "data": {
3     "active": true,
4     "automatically_add_new_fields": "all",
5     "automatically_add_new_objects": "all",
6     "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
7     "destination_configuration": {
8       "schema": "my_schema"
9     },
10     "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
11     "disable_record_timestamps": false,
12     "discover": true,
13     "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
14     "mode": "replace",
15     "name": "My Bulk Sync",
16     "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
17     "policies": [
18       "248df4b7-aa70-47b8-a036-33ac447e668d"
19     ],
20     "schedule": {
21       "frequency": "manual",
22       "day_of_month": "1",
23       "day_of_week": "monday",
24       "hour": "0",
25       "minute": "0",
26       "month": "1"
27     },
28     "source_configuration": {
29       "replication_slot": "slot"
30     },
31     "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
32   }
33 }

Remove Bulk Sync

Up Next

1	curl -G https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \
2	-H "Authorization: Bearer <token>" \
3	-d refresh_schemas=true

1	{
2	"data": {
3	"active": true,
4	"automatically_add_new_fields": "all",
5	"automatically_add_new_objects": "all",
6	"data_cutoff_timestamp": "2023-04-25T12:00:00Z",
7	"destination_configuration": {
8	"schema": "my_schema"
9	},
10	"destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
11	"disable_record_timestamps": false,
12	"discover": true,
13	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
14	"mode": "replace",
15	"name": "My Bulk Sync",
16	"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
17	"policies": [
18	"248df4b7-aa70-47b8-a036-33ac447e668d"
19	],
20	"schedule": {
21	"frequency": "manual",
22	"day_of_month": "1",
23	"day_of_week": "monday",
24	"hour": "0",
25	"minute": "0",
26	"month": "1"
27	},
28	"source_configuration": {
29	"replication_slot": "slot"
30	},
31	"source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
32	}
33	}