SyncSheets provides a comprehensive REST API that powers the admin interface and can be used for custom integrations. All endpoints require the manage_options capability (WordPress administrator).
Base URL
All endpoints are under: wp-json/syncsheets/v1/
Authentication Endpoints
GET /auth/status— Check Google connection status.POST /auth/credentials— Save Google API Client ID and Secret.GET /auth/url— Get the OAuth authorization URL.GET /auth/callback— OAuth callback handler (used by Google redirect).POST /auth/disconnect— Disconnect the Google account.GET /auth/account— Get connected account information.
Provider Endpoints
GET /providers— List all available data providers.GET /providers/{id}/fields— Get fields for a specific provider.GET /providers/{id}/filters— Get filter options for a provider.GET /providers/{id}/triggers— Get available real-time triggers.
Spreadsheet Endpoints
GET /spreadsheets— List user’s Google Sheets.GET /spreadsheets/{id}/tabs— List tabs in a spreadsheet.GET /sheets/{spreadsheet_id}/headers/{tab}— Get column headers from a sheet tab.POST /spreadsheets/create— Create a new spreadsheet.POST /spreadsheets/{id}/tabs— Create a new tab in a spreadsheet.
Job Endpoints
GET /jobs— List all sync jobs.POST /jobs— Create a new sync job.GET /jobs/{id}— Get details of a specific job.PUT /jobs/{id}— Update a sync job.DELETE /jobs/{id}— Delete a sync job.POST /jobs/{id}/run— Run a job immediately.POST /jobs/{id}/test-run— Test run a job (limited to 10 rows).POST /jobs/{id}/duplicate— Duplicate a job.POST /jobs/{id}/pause— Pause a job.POST /jobs/{id}/resume— Resume a paused job.
Bulk Processing Endpoints
POST /bulk/export— Start a bulk export.POST /bulk/import— Start a bulk import.GET /bulk/status/{job_id}— Check bulk job progress.POST /bulk/cancel/{job_id}— Cancel a running bulk job.
Utility Endpoints
POST /field-mapper/auto-map— Auto-detect field mapping.POST /field-mapper/validate— Validate a field mapping.GET /cpt/list— List registered custom post types.GET /scheduler/intervals— Get available schedule intervals.GET /logs— Fetch sync logs with filters.POST /logs/clear— Clear all sync logs.GET /debug-report— Get system debug information.
Authentication
All API requests require WordPress authentication with administrator privileges. When calling from the admin interface, the WordPress nonce is automatically included. For external API calls, use cookie authentication or an application password.