API ReferenceBulk Sync

Get Bulk Sync

GET

Path parameters

idstringRequired

Query parameters

refresh_schemasbooleanOptional

Response

This endpoint returns an object

data

objectOptional

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

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

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	"destination_configuration": {
5	"schema": "my_schema"
6	},
7	"destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
8	"discover": true,
9	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
10	"mode": "replace",
11	"name": "My Bulk Sync",
12	"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
13	"policies": [
14	"248df4b7-aa70-47b8-a036-33ac447e668d"
15	],
16	"schedule": {
17	"frequency": "manual",
18	"day_of_month": "1",
19	"day_of_week": "monday",
20	"hour": "0",
21	"minute": "0",
22	"month": "1"
23	},
24	"source_configuration": {
25	"replication_slot": "slot"
26	},
27	"source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
28	}
29	}