Syncs

Get sync status

A cached live snapshot: pending pushes, per-side polling state, and change detection.

get/v1/sync/syncs/{sync_id}/status

Request

  • Base URL: https://api.whalesync.com
  • URL: https://api.whalesync.com/v1/sync/syncs/{sync_id}/status
  • Auth: HTTP bearer

Path parameters

sync_idstring required
Example:sync_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41

Response

The current status snapshot.

sync_idstring required
status'draft' | 'active' | 'paused' required
pending_pushesnumber required

Records waiting to be written, across both sides.

last_synced_atstring date-time nullable required

When the sync last polled, or null if never.

fetched_atstring date-time required

When this snapshot was taken.

Example response

{
  "sync_id": "sync_9f2c…"
}

Changes

No recorded changes to this operation across all 1 revision of this API.