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 Schedule

GET
https://app.polytomic.com/api/bulk/syncs/:sync_id/schedules/:schedule_id
GET
/api/bulk/syncs/:sync_id/schedules/:schedule_id
$curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schedules/248df4b7-aa70-47b8-a036-33ac447e668d \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": {
3    "frequency": "weekly",
4    "createdAt": "2024-01-15T09:30:00Z",
5    "createdBy": "a3f1c2d4-5b6e-7f89-0123-456789abcdef",
6    "dayOfMonth": "15",
7    "dayOfWeek": "Monday",
8    "deletedAt": null,
9    "deletedBy": null,
10    "hour": "14",
11    "isDefault": true,
12    "minute": "30",
13    "month": "March",
14    "schemas": [
15      "customer_data",
16      "order_data"
17    ],
18    "selectiveMode": "incrementalFields",
19    "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
20    "syncMode": "normal",
21    "updatedAt": "2024-04-10T12:45:00Z",
22    "updatedBy": "b7e8f9a0-1234-5678-9abc-def012345678"
23  }
24}
Returns a single schedule configured on a bulk sync. Schedule times are returned in UTC. To see all schedules on this sync, use [`GET /api/bulk/syncs/{sync_id}/schedules`](../../../../../../api-reference/bulk-sync/schedules/list). To update the schedule, use [`PUT /api/bulk/syncs/{sync_id}/schedules/{schedule_id}`](../../../../../../api-reference/bulk-sync/schedules/update).
Was this page helpful?
Previous

Update Bulk Sync Schedule

Next

Returns a single schedule configured on a bulk sync.

Schedule times are returned in UTC.

To see all schedules on this sync, use GET /api/bulk/syncs/{sync_id}/schedules. To update the schedule, use PUT /api/bulk/syncs/{sync_id}/schedules/{schedule_id}.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

sync_idstringRequiredformat: "uuid"
Unique identifier of the bulk sync.
schedule_idstringRequiredformat: "uuid"
Unique identifier of the schedule.

Headers

X-Polytomic-VersionstringOptional

Response

OK
dataobject

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error