---
title: "Get sync status"
method: GET
path: "/v1/sync/syncs/{sync_id}/status"
tags: ["Syncs"]
---

# Get sync status

`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

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

## Path parameters

- `sync_id` string, required

## Response `200`

The current status snapshot.

- SyncStatus
  - `sync_id` string, required
  - `status` 'draft' | 'active' | 'paused', required
  - `pending_pushes` number, required: Records waiting to be written, across both sides.
  - `last_synced_at` string, date-time, nullable, required: When the sync last polled, or null if never.
  - `left` SyncStatusSide, required
    - `side` 'left' | 'right', required
    - `polling` boolean, required: Whether this side is polling for or fetching changes right now.
    - `initializing` boolean, required: Whether this side is still running its first sync.
    - `change_detection` 'webhooks' | 'polling', required: How changes on this side are picked up.
  - `right` SyncStatusSide, required
    - `side` 'left' | 'right', required
    - `polling` boolean, required: Whether this side is polling for or fetching changes right now.
    - `initializing` boolean, required: Whether this side is still running its first sync.
    - `change_detection` 'webhooks' | 'polling', required: How changes on this side are picked up.
  - `fetched_at` string, date-time, required: When this snapshot was taken.

## Other responses

- `401`: The API key is missing, invalid, or revoked (`missing_api_key`, `invalid_api_key`). Carries a `required_action` linking a person to key creation, naming the smallest scope this endpoint needs.
- `403`: The key's scope does not allow this call (`insufficient_scope` on a mutation with a `read` key).
- `404`: No such sync on this account.
- `429`: Rate limit exceeded. Wait for `Retry-After` seconds.

---

[API](https://skmtc.dev/whalesync/apis/whalesync-api.md) · [All operations](https://skmtc.dev/whalesync/apis/whalesync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whalesync/apis/whalesync-api/revisions/5131522b325a?raw)