# Whalesync API

**Canonical:** https://apis.io/apis/whalesync/whalesync-api/  
**Provider:** Whalesync — https://apis.io/providers/whalesync/  
**Base URL:** https://api.whalesync.com/v1  
**Documentation:** https://docs.whalesync.com/api/errors

Whalesync API is published by [Whalesync](https://apis.io/providers/whalesync/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Whalesync API as documented publicly: 45 operations. Contract generated from the documentation by API Evangelist (2026-10-26); not the provider's own document.

## Operations (45)

| Method | Path | Summary |
|---|---|---|
| GET | `/live-export/connectors` | Connectors usable for Live Export, with roles and auth. |
| GET | `/live-export/live-exports` | List, newest first (limit 1–25, default 10). |
| POST | `/live-export/live-exports` | POST /live-export/live-exports Create a Live Export. |
| DELETE | `/live-export/live-exports/{id}` | Delete the export and its schedule. Destination tables stay. |
| GET | `/live-export/live-exports/{id}` | One live export. |
| PATCH | `/live-export/live-exports/{id}` | Rename, finish an API-key side's auth, set the destination location. |
| GET | `/live-export/live-exports/{id}/destination/locations` | Where created tables can live (?search=). |
| GET | `/live-export/live-exports/{id}/mappings` | The mappings document (+ ETag). |
| PUT | `/live-export/live-exports/{id}/mappings` | Full replace the mappings document for a live export. |
| POST | `/live-export/live-exports/{id}/mappings/validate` | Check a mappings document without saving it. |
| GET | `/live-export/live-exports/{id}/save` | Poll the save operation for completion. |
| POST | `/live-export/live-exports/{id}/save` | Create destination tables and apply the mappings. |
| GET | `/live-export/live-exports/{id}/schedule` | Retrieve the schedule settings for a live export. |
| PATCH | `/live-export/live-exports/{id}/schedule` | Create or update the schedule for a live export. |
| GET | `/live-export/live-exports/{id}/source/tables` | Exportable source tables. |
| GET | `/live-export/live-exports/{id}/source/tables/{tableId}/fields` | One table's exportable fields, with planned destination name and type. |
| GET | `/live-export/live-exports/{id}/status` | Get live snapshot of export status and next run. |
| POST | `/live-export/live-exports/{id}/trigger` | POST /live-export/live-exports/{id}/trigger Trigger a Live Export run. |
| GET | `/live-export/runs` | List run history for a live export. |
| GET | `/live-export/runs/{id}` | Retrieve details of a specific run. |
| POST | `/live-export/runs/{id}/cancel` | POST /live-export/runs/{id}/cancel Cancel a Live Export run. |
| GET | `/sync/connectors` | GET /sync/connectors All connectors: type slug, auth method, credential fields, capabilities. |
| GET | `/sync/issues` | Open issues, with remediation guidance. |
| GET | `/sync/issues/{id}` | Get a single issue. |
| POST | `/sync/issues/{id}/retry` | POST /sync/issues/{id}/retry Clear an issue and retry the failed work. |
| GET | `/sync/operations` | Record-level change log (filter by sync). |
| GET | `/sync/operations/{id}` | Get a single operation record. |
| GET | `/sync/pending-deletes` | GET /sync/pending-deletes?sync=… One sync's deletes waiting on a person, newest first. |
| GET | `/sync/records` | GET /sync/records?sync=…&query=… Find records by remote id, rec_ id, or display text. |
| GET | `/sync/records/{recordId}` | GET /sync/records/{record_id} Everything known about one record's sync state. |
| POST | `/sync/records/{recordId}/refetch` | POST /sync/records/{record_id}/refetch Fetch the record again from the connected app. |
| GET | `/sync/syncs` | GET /sync/syncs List syncs with status + open_issues. |
| POST | `/sync/syncs` | POST /sync/syncs Create a sync with both sides declared. |
| DELETE | `/sync/syncs/{syncId}` | Stops the sync and deletes it. |
| GET | `/sync/syncs/{syncId}` | Full sync incl. per-side status and next-step URLs. |
| PATCH | `/sync/syncs/{syncId}` | PATCH /sync/syncs/{sync_id} Rename, amend a side while draft, update a side's auth. |
| POST | `/sync/syncs/{syncId}/activate` | POST /sync/syncs/{sync_id}/activate Turn a paused sync back on. |
| GET | `/sync/syncs/{syncId}/mappings` | Current mappings document (+ ETag). |
| PUT | `/sync/syncs/{syncId}/mappings` | Full replace of mappings document. |
| POST | `/sync/syncs/{syncId}/pause` | POST /sync/syncs/{sync_id}/pause Turn an active sync off. |
| GET | `/sync/syncs/{syncId}/sides/{side}/bases` | GET /sync/syncs/{sync_id}/sides/{side}/bases Retrieve bases/workspaces a side's credentials can reach. |
| GET | `/sync/syncs/{syncId}/status` | Live snapshot: pending pushes, polling state, change detection. |
| GET | `/sync/syncs/{syncId}/tables` | Tables on one side. |
| GET | `/sync/syncs/{syncId}/tables/{tableId}/fields` | Fields with type metadata. |
| POST | `/sync/syncs/{syncId}/validate` | Check a mappings document (body optional; defaults to stored one). |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/whalesync/openapi/_ae-authored/whalesync-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/whalesync/json-schema/whalesync-get-sync-records-recordid-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/whalesync/json-schema/whalesync-get-sync-syncs-syncid-tables-tableid-fields-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/whalesync/json-schema/whalesync-get-live-export-live-exports-id-status-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/whalesync/json-schema/whalesync-get-live-export-runs-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/whalesync/json-schema/whalesync-get-live-export-live-exports-id-schedule-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/whalesync/json-schema/whalesync-post-live-export-live-exports-id-save-response-schema.json
- **APIsJSON** — https://artifacts.apis.io/whalesync/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/whalesync/whalesync-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/whalesync/.