How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Whalesync

Whalesync API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Whalesync API is published by Whalesync on the 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.

This API exposes 45 operations across 35 paths, organized into 2 resource areas, and defines 41 schemas. It is described by OpenAPI 3.1.0, at version 2026-10-26.

Requests are made against a single base URL, https://api.whalesync.com/v1.

45 operations 35 paths 41 schemas 2 DELETE27 GET3 PATCH11 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2026-10-26
Base URL
https://api.whalesync.com/v1
Resource Areas
2

Paths & Operations 45

Across 35 paths, the API surfaces 45 operations — 2 DELETE, 27 GET, 3 PATCH, 11 POST, 2 PUT. They span 2 resource areas: Live Export, Sync. Each is listed below with its method, path, parameters, and response codes.

Live Export 21
GET
/live-export/connectors
Connectors usable for Live Export, with roles and auth.
get_live_export_connectors → 200
GET
/live-export/live-exports
List, newest first (limit 1–25, default 10).
get_live_export_live_exports 2 params → 200
POST
/live-export/live-exports
POST /live-export/live-exports Create a Live Export.
post_live_export_live_exports body → 201
DELETE
/live-export/live-exports/{id}
Delete the export and its schedule. Destination tables stay.
delete_live_export_live_exports_id 1 param → 200
GET
/live-export/live-exports/{id}
One live export.
get_live_export_live_exports_id 1 param → 200
PATCH
/live-export/live-exports/{id}
Rename, finish an API-key side's auth, set the destination location.
patch_live_export_live_exports_id 1 param body → 200
GET
/live-export/live-exports/{id}/destination/locations
Where created tables can live (?search=).
get_live_export_live_exports_id_destination_locations 2 params → 200
GET
/live-export/live-exports/{id}/mappings
The mappings document (+ ETag).
get_live_export_live_exports_id_mappings 1 param → 200
PUT
/live-export/live-exports/{id}/mappings
Full replace the mappings document for a live export.
put_live_export_live_exports_id_mappings 1 param body → 200
POST
/live-export/live-exports/{id}/mappings/validate
Check a mappings document without saving it.
post_live_export_live_exports_id_mappings_validate 1 param body → 201
GET
/live-export/live-exports/{id}/save
Poll the save operation for completion.
get_live_export_live_exports_id_save 2 params → 200
POST
/live-export/live-exports/{id}/save
Create destination tables and apply the mappings.
post_live_export_live_exports_id_save 1 param → 201
GET
/live-export/live-exports/{id}/schedule
Retrieve the schedule settings for a live export.
get_live_export_live_exports_id_schedule 1 param → 200
PATCH
/live-export/live-exports/{id}/schedule
Create or update the schedule for a live export.
patch_live_export_live_exports_id_schedule 1 param body → 200
GET
/live-export/live-exports/{id}/source/tables
Exportable source tables.
get_live_export_live_exports_id_source_tables 1 param → 200
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_source_tables_tableId_fields 2 params → 200
GET
/live-export/live-exports/{id}/status
Get live snapshot of export status and next run.
get_live_export_live_exports_id_status 1 param → 200
POST
/live-export/live-exports/{id}/trigger
POST /live-export/live-exports/{id}/trigger Trigger a Live Export run.
post_live_export_live_exports_id_trigger 1 param → 201
GET
/live-export/runs
List run history for a live export.
get_live_export_runs 1 param → 200
GET
/live-export/runs/{id}
Retrieve details of a specific run.
get_live_export_runs_id 1 param → 200
POST
/live-export/runs/{id}/cancel
POST /live-export/runs/{id}/cancel Cancel a Live Export run.
post_live_export_runs_id_cancel 1 param → 201
Sync 24
GET
/sync/connectors
GET /sync/connectors All connectors: type slug, auth method, credential fields, capabilities.
get_sync_connectors → 200
GET
/sync/issues
Open issues, with remediation guidance.
get_sync_issues 1 param → 200
GET
/sync/issues/{id}
Get a single issue.
get_sync_issues_id 1 param → 200
POST
/sync/issues/{id}/retry
POST /sync/issues/{id}/retry Clear an issue and retry the failed work.
post_sync_issues_id_retry 1 param → 201
GET
/sync/operations
Record-level change log (filter by sync).
get_sync_operations 1 param → 200
GET
/sync/operations/{id}
Get a single operation record.
get_sync_operations_id 1 param → 200
GET
/sync/pending-deletes
GET /sync/pending-deletes?sync=… One sync's deletes waiting on a person, newest first.
get_sync_pending_deletes 4 params → 200
GET
/sync/records
GET /sync/records?sync=…&query=… Find records by remote id, rec id, or display text.
get_sync_records 3 params → 200
GET
/sync/records/{recordId}
GET /sync/records/{recordid} Everything known about one record's sync state.
get_sync_records_recordId 3 params → 200
POST
/sync/records/{recordId}/refetch
POST /sync/records/{recordid}/refetch Fetch the record again from the connected app.
post_sync_records_recordId_refetch 1 param body → 201
GET
/sync/syncs
GET /sync/syncs List syncs with status + openissues.
get_sync_syncs → 200
POST
/sync/syncs
POST /sync/syncs Create a sync with both sides declared.
post_sync_syncs body → 201
DELETE
/sync/syncs/{syncId}
Stops the sync and deletes it.
delete_sync_syncs_syncId 1 param → 200
GET
/sync/syncs/{syncId}
Full sync incl. per-side status and next-step URLs.
get_sync_syncs_syncId 1 param → 200
PATCH
/sync/syncs/{syncId}
PATCH /sync/syncs/{syncid} Rename, amend a side while draft, update a side's auth.
patch_sync_syncs_syncId 1 param body → 200
POST
/sync/syncs/{syncId}/activate
POST /sync/syncs/{syncid}/activate Turn a paused sync back on.
post_sync_syncs_syncId_activate 1 param → 201
GET
/sync/syncs/{syncId}/mappings
Current mappings document (+ ETag).
get_sync_syncs_syncId_mappings 1 param → 200
PUT
/sync/syncs/{syncId}/mappings
Full replace of mappings document.
put_sync_syncs_syncId_mappings 1 param body → 200
POST
/sync/syncs/{syncId}/pause
POST /sync/syncs/{syncid}/pause Turn an active sync off.
post_sync_syncs_syncId_pause 1 param → 201
GET
/sync/syncs/{syncId}/sides/{side}/bases
GET /sync/syncs/{syncid}/sides/{side}/bases Retrieve bases/workspaces a side's credentials can reach.
get_sync_syncs_syncId_sides_side_bases 2 params → 200
GET
/sync/syncs/{syncId}/status
Live snapshot: pending pushes, polling state, change detection.
get_sync_syncs_syncId_status 1 param → 200
GET
/sync/syncs/{syncId}/tables
Tables on one side.
get_sync_syncs_syncId_tables 3 params → 200
GET
/sync/syncs/{syncId}/tables/{tableId}/fields
Fields with type metadata.
get_sync_syncs_syncId_tables_tableId_fields 2 params → 200
POST
/sync/syncs/{syncId}/validate
Check a mappings document (body optional; defaults to stored one).
post_sync_syncs_syncId_validate 1 param body → 201

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are GetSyncSyncsSyncidTablesTableidFieldsResponse (9 properties), GetLiveExportRunsIdResponse (8 properties), GetLiveExportLiveExportsIdStatusResponse (7 properties), GetSyncRecordsRecordidResponse (7 properties). Each schema is shown below with its type and property counts.

GetLiveExportConnectorsResponse
object
1 property
GetLiveExportLiveExportsResponse
object
1 property
PostLiveExportLiveExportsRequest
object
3 properties 3 required
PostLiveExportLiveExportsResponse
object
2 properties
DeleteLiveExportLiveExportsIdResponse
object
2 properties
GetLiveExportLiveExportsIdResponse
object
3 properties
PatchLiveExportLiveExportsIdRequest
object
3 properties
PatchLiveExportLiveExportsIdResponse
object
1 property
GetLiveExportLiveExportsIdDestinationLocationsResponse
object
2 properties
GetLiveExportLiveExportsIdMappingsResponse
object
2 properties
PutLiveExportLiveExportsIdMappingsRequest
object
2 properties 1 required
PutLiveExportLiveExportsIdMappingsResponse
object
2 properties
PostLiveExportLiveExportsIdMappingsValidateRequest
object
1 property 1 required
PostLiveExportLiveExportsIdMappingsValidateResponse
object
2 properties
GetLiveExportLiveExportsIdSaveResponse
object
5 properties
PostLiveExportLiveExportsIdSaveResponse
object
5 properties
GetLiveExportLiveExportsIdScheduleResponse
object
7 properties
PatchLiveExportLiveExportsIdScheduleRequest
object
3 properties
PatchLiveExportLiveExportsIdScheduleResponse
object
3 properties
GetLiveExportLiveExportsIdSourceTablesResponse
object
1 property
GetLiveExportLiveExportsIdSourceTablesTableidFieldsResponse
object
1 property
GetLiveExportLiveExportsIdStatusResponse
object
7 properties
GetLiveExportRunsResponse
object
2 properties
GetLiveExportRunsIdResponse
object
8 properties
GetSyncConnectorsResponse
object
3 properties
GetSyncPendingDeletesResponse
object
3 properties
GetSyncRecordsResponse
object
3 properties
GetSyncRecordsRecordidResponse
object
7 properties
PostSyncRecordsRecordidRefetchRequest
object
1 property
PostSyncRecordsRecordidRefetchResponse
object
2 properties
GetSyncSyncsResponse
object
3 properties
PostSyncSyncsRequest
object
3 properties 3 required
PostSyncSyncsResponse
object
2 properties
DeleteSyncSyncsSyncidResponse
object
2 properties
PatchSyncSyncsSyncidRequest
object
3 properties
PatchSyncSyncsSyncidResponse
object
2 properties
PutSyncSyncsSyncidMappingsRequest
object
1 property 1 required
GetSyncSyncsSyncidSidesSideBasesResponse
object
1 property
GetSyncSyncsSyncidTablesTableidFieldsResponse
object
9 properties
PostSyncSyncsSyncidValidateRequest
object
1 property
PostSyncSyncsSyncidValidateResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whalesync-openapi-generated.yml Raw ↑
← Back to W APIs
API Details
ID
whalesync:whalesync-api
Base URL
https://api.whalesync.com/v1
Docs
https://docs.whalesync.com/api/errors
Provider
Whalesync
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=whalesync-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/whalesync-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Whalesync API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.