For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETList Bulk Syncs
      • POSTCreate Bulk Sync
      • GETGet Bulk Sync
      • PUTUpdate Bulk Sync
      • DELDelete Bulk Sync
      • POSTActivate Bulk Sync
      • POSTCancel Bulk Sync
      • POSTStart Bulk Sync Execution
      • GETGet Bulk Sync Status
      • GETGet Bulk Source
      • GETGet Bulk Destination
        • GETGet Bulk Sync Schedules
        • POSTCreate Bulk Sync Schedule
        • GETGet Bulk Sync Schedule
        • PUTUpdate Bulk Sync Schedule
        • DELDelete Bulk Sync Schedule
Logo
Log inBook a demo
API ReferenceBulk SyncSchedules

Get Bulk Sync Schedules

GET
https://app.polytomic.com/api/bulk/syncs/:sync_id/schedules
GET
/api/bulk/syncs/:sync_id/schedules
$curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schedules \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": [
3    {
4      "frequency": "weekly",
5      "createdAt": "2024-01-15T09:30:00Z",
6      "createdBy": "a3f1c2d4-5b6e-7f89-0123-456789abcdef",
7      "dayOfMonth": "15",
8      "dayOfWeek": "Monday",
9      "deletedAt": null,
10      "deletedBy": null,
11      "hour": "14",
12      "isDefault": true,
13      "minute": "30",
14      "month": "January",
15      "schemas": [
16        "customer_data",
17        "order_data"
18      ],
19      "selectiveMode": "incrementalFields",
20      "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
21      "syncMode": "normal",
22      "updatedAt": "2024-04-10T12:00:00Z",
23      "updatedBy": "b7e8f9a0-1234-5678-9abc-def012345678"
24    },
25    {
26      "frequency": "daily",
27      "createdAt": "2024-02-01T08:00:00Z",
28      "createdBy": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
29      "dayOfMonth": "1",
30      "dayOfWeek": null,
31      "deletedAt": null,
32      "deletedBy": null,
33      "hour": "02",
34      "isDefault": false,
35      "minute": "00",
36      "month": null,
37      "schemas": [
38        "inventory"
39      ],
40      "selectiveMode": "none",
41      "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
42      "syncMode": "resync",
43      "updatedAt": "2024-05-01T07:45:00Z",
44      "updatedBy": "d4e5f6a7-8901-2345-6789-abcdef012345"
45    }
46  ]
47}

Lists all schedules configured for a bulk sync.

A bulk sync can have multiple schedules attached; this endpoint returns all of them. Schedule times are returned in UTC.

Was this page helpful?
Previous

Create Bulk Sync Schedule

Next

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

sync_idstringRequiredformat: "uuid"
Unique identifier of the bulk sync whose schedules should be returned.

Headers

X-Polytomic-VersionstringOptional

Response

OK
datalist of objects or null

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error