Black Friday: 40% off every Pro planGet 40% off

PushRow REST API Reference

Available in: Free and Pro (endpoints marked Pro need Pro)

The PushRow admin screens run on a REST API that you can also use in your own code. All endpoints are under:

/wp-json/pushrow/v1/

Authentication

Every endpoint needs a logged-in user with the manage_options capability (an administrator), except two:

  • GET /auth/callback is public, because Google redirects to it after sign-in.
  • POST /webhook/sheet-push/{job_id} (Pro) is public and checks the job’s secret in the X-PushRow-Secret header.

From your own admin code, send the REST nonce. From outside WordPress, use an application password.

Google connection

  • GET /auth/status: connection status.
  • POST /auth/credentials: save the Client ID and Client Secret.
  • GET /auth/url: the Google authorization URL.
  • GET /auth/callback: OAuth callback used by Google.
  • POST /auth/disconnect: disconnect the Google account.
  • GET /auth/account: the connected account.

Providers and targets

  • GET /providers: data types available for export.
  • GET /providers/{id}/fields: a data type’s fields.
  • GET /providers/{id}/filters: a data type’s filters.
  • GET /providers/{id}/triggers: real-time triggers. The free plugin returns an empty list.
  • GET /targets (Pro): import destinations.
  • GET /targets/{id}/fields, GET /targets/{id}/unique-keys, GET /targets/{id}/settings (Pro).
  • GET /targets/db_table/table-fields and GET /targets/db_table/table-unique-keys (Pro): columns and keys of a database table.
  • GET /cpt/list (Pro): registered custom post types.

Spreadsheets

  • GET /spreadsheets: your spreadsheets.
  • POST /spreadsheets/create: create a spreadsheet.
  • GET /spreadsheets/{id}/tabs: a spreadsheet’s tabs.
  • POST /spreadsheets/{id}/tabs: create a tab.
  • GET /sheets/{spreadsheet_id}/headers/{tab}: a tab’s header row.

Jobs

  • GET /jobs and POST /jobs: list or create jobs.
  • GET /jobs/{id}, PUT /jobs/{id}, DELETE /jobs/{id}: read, update or delete a job.
  • POST /jobs/{id}/run: run a job now.
  • POST /jobs/{id}/test-run: run a job for 10 rows.
  • POST /jobs/{id}/duplicate, POST /jobs/{id}/pause, POST /jobs/{id}/resume.
  • GET /jobs/{id}/apps-script (Pro): a Google Apps Script that pushes sheet edits to the job’s webhook.
  • POST /jobs/{id}/generate-webhook-secret (Pro): create the job’s webhook secret.
  • POST /webhook/sheet-push/{job_id} (Pro): receives rows pushed by that script.
  • POST /export and POST /import: run an export or import from a job profile (older endpoints).

Bulk processing (Pro)

  • POST /bulk/export and POST /bulk/import: start a background bulk job.
  • GET /bulk/status/{job_id}: progress.
  • POST /bulk/cancel/{job_id}: cancel.

Utilities

  • POST /field-mapper/auto-map: match sheet headers to fields.
  • POST /field-mapper/validate: check a mapping.
  • GET /scheduler/intervals: schedule intervals.
  • GET /logs and POST /logs/clear: read or clear the sync logs.
  • GET /debug-report: system details for support.

Was this page helpful? If something is unclear or missing, tell the developer.