Get Bulk Sync Schedules | Polytomic Docs

curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schedules \
     -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": "January",
      "schemas": [
        "customer_data",
        "order_data"
      ],
      "selectiveMode": "incrementalFields",
      "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "syncMode": "normal",
      "updatedAt": "2024-04-10T12:00:00Z",
      "updatedBy": "b7e8f9a0-1234-5678-9abc-def012345678"
    },
    {
      "frequency": "daily",
      "createdAt": "2024-02-01T08:00:00Z",
      "createdBy": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
      "dayOfMonth": "1",
      "dayOfWeek": null,
      "deletedAt": null,
      "deletedBy": null,
      "hour": "02",
      "isDefault": false,
      "minute": "00",
      "month": null,
      "schemas": [
        "inventory"
      ],
      "selectiveMode": "none",
      "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "syncMode": "resync",
      "updatedAt": "2024-05-01T07:45:00Z",
      "updatedBy": "d4e5f6a7-8901-2345-6789-abcdef012345"
    }
  ]
}

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.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

sync_idstringRequiredformat: "uuid"

Unique identifier of the bulk sync whose schedules should be returned.

Response

datalist of objects or null

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors