---
title: "List active data syncs"
method: GET
path: "/data/list_active_syncs"
tags: ["Data Sync", "beta"]
---

# List active data syncs

`GET /data/list_active_syncs`

## Request

- Base URL: `https://happy-animal-123.convex.cloud/api/v1`
- URL: `https://happy-animal-123.convex.cloud/api/v1/data/list_active_syncs`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `Authorization`
  - API key in header `Authorization`
  - API key in header `Authorization`

Returns the progress of active data sync (/v1/data/sync).

A data sync is considered active for 3 days after the most recent API call.
from `/data/sync` within the past 3 days.

## Query parameters

- `limit` integer, nullable
- `cursor` string, nullable

## Response `200`

- ListActiveSyncsResponse: Response of the active-syncs listing API (`/api/v1/data/list_active_syncs`).
  - `syncs` ActiveDataSync[], required: Page of active data syncs, most recently updated first. A sync is active if it fetched a page from `/api/v1/data/sync` within the past 3 days.
    - `syncId` string, required: Unique id of the sync, assigned when it started (i.e. when `/api/v1/data/sync` was called without a cursor) and stable across its pages.
    - `lastUpdated` integer, required: Wall-clock time of the last `/data/sync` call made by this sync, as a unix timestamp in milliseconds.
    - `status` union, required: The progress of an active data sync, discriminated by `type`.
      - ActiveDataSyncSnapshotting: The sync is still traversing its selected tables; the data returned so far is not yet a consistent snapshot.
        - `type` 'snapshotting', required: The literal string `snapshotting`, discriminating "snapshotting" status objects.
        - `numTablesSynced` integer, required: Tables whose initial traversal has completed.
        - `totalTables` integer, required: Total tables selected for the sync.
        - `currentComponent` string, required: The component of the table currently being traversed (the empty string for the root component).
        - `currentTable` string, required: The table currently being traversed.
        - `numDocumentsInCurrentTable` integer, required: Documents synced so far from the current table.
        - `totalDocumentsInCurrentTable` integer, required: Total documents in the current table, as of a recent snapshot.
        - `numDocumentsSynced` integer, required: Documents synced over the sync's lifetime, including deletions and re-synced revisions of documents that changed mid-sync — so this can slightly exceed `totalDocuments`.
        - `totalDocuments` integer, required: Total documents across all selected tables, as of a recent snapshot.
      - ActiveDataSyncStale: The sync reached a consistent snapshot at `syncedTs`, but newer data is already available; it is streaming later changes (CDC).
        - `type` 'stale', required: The literal string `stale`, discriminating "stale" status objects.
        - `totalTables` integer, required: Total tables selected for the sync.
        - `numDocumentsSynced` integer, required: Documents synced over the sync's lifetime, including deletions and re-synced revisions.
        - `syncedTs` integer, required: The database timestamp at which the synced data is consistent.
      - ActiveDataSyncUpToDate: The sync reached a consistent snapshot at `syncedTs` and has caught up to the latest data.
        - `type` 'upToDate', required: The literal string `upToDate`, discriminating "up to date" status objects.
        - `totalTables` integer, required: Total tables selected for the sync.
        - `numDocumentsSynced` integer, required: Documents synced over the sync's lifetime, including deletions and re-synced revisions.
        - `syncedTs` integer, required: The database timestamp at which the synced data is consistent.
  - `pagination` PaginationMetadata, required
    - `hasMore` boolean, required
    - `nextCursor` string, nullable

---

[API](https://skmtc.dev/operatornest/apis/convex-deployment-api.md) · [All operations](https://skmtc.dev/operatornest/apis/convex-deployment-api/llms.txt) · [OpenAPI document](https://skmtc.dev/operatornest/apis/convex-deployment-api/revisions/bd0de6c553a7?raw)