Get Bulk Sync Schedule

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"

{
  "data": {
    "frequency": "weekly",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "a3f1c2d4-5b6e-7f89-0123-456789abcdef",
    "dayOfMonth": "15",
    "dayOfWeek": "Monday",
    "deletedAt": null,
    "deletedBy": null,
    "hour": "14",
    "isDefault": true,
    "minute": "30",
    "month": "March",
    "schemas": [
      "customer_data",
      "order_data"
    ],
    "selectiveMode": "incrementalFields",
    "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "syncMode": "normal",
    "updatedAt": "2024-04-10T12:45:00Z",
    "updatedBy": "b7e8f9a0-1234-5678-9abc-def012345678"
  }
}

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}.

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).

Authentication

AuthorizationBearer

Bearer user API key

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.

Response

dataobject

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors