Sheetgo API

Note for AI agents: this page is rendered by JavaScript. The full documentation is available as plain text at https://dev-api.sheetgo.com/rest/reference.md, and all of it in one file at https://dev-api.sheetgo.com/rest/llms-full.txt.

This is a summary. Before writing a request, fetch the group page of the endpoint and every model page it links. Do not guess fields that are not shown here.

Start page (plain text): https://dev-api.sheetgo.com/rest/reference.md. Everything in one file: https://dev-api.sheetgo.com/rest/llms-full.txt. The group pages are listed under Endpoints below.

What this API is

The Sheetgo Public API manages your workflows, automations and forms and reads the data they produce. An automation moves data from sources (files, folders, APIs, email, BigQuery) to destinations (files, documents, PDFs, email, APIs), optionally through processors. Authenticate with an API key.

Base URL: https://dev-api.sheetgo.com. Every endpoint below is under /rest/. Requests and responses are JSON.

How to read these docs

The start page lists every endpoint and links to the page that documents it. It is a summary, not the full reference.

  1. Find your endpoint in the Endpoints list below and fetch the group page it belongs to.
  2. A group page links each request and response body to a model page. Fetch the model page before you build a body.
  3. Fetch a guide when an endpoint links to one (smart tags, cell references, rate limiting, and so on).
  4. Do not guess fields that are not shown here. If a field, value or endpoint is not on these pages, it does not exist; fetch the page that should show it or say that you could not find it.

The model pages are listed on the full start page https://dev-api.sheetgo.com/rest/reference.md.

Authentication

Send an API key as a Bearer token on every request. Generate one on your Sheetgo Account page. Keys start with sg_.

Authorization: Bearer sg_your_api_key

OAuth2 (authorization code flow) is available for integrations: /rest/auth/authorize, /rest/auth/token, /rest/auth/refresh. The token request body is form-encoded, not JSON.

A key can be limited to some actions and items. See API Key Scopes.

Conventions

Quickstart

Four calls take you from nothing to a finished run. Replace the placeholder ids (WORKFLOW_ID, SOURCE_FILE_ID, DEST_FILE_ID) with real ones.

  1. GET /rest/beta/workflows/ lists your workflows. Take the id of one. The envelope's total counts pages, not rows.
  2. POST /rest/beta/automations/ creates an automation (note the trailing slash). This one copies a tab of a Google Sheet into a tab of another:
{
  "workflow_id": "WORKFLOW_ID",
  "name": "Copy sales",
  "sources": [
    {
      "type": "file",
      "provider": "drive",
      "id": "SOURCE_FILE_ID",
      "file_type": "gsheets",
      "sheet_tabs": [
        "Sales"
      ]
    }
  ],
  "destinations": [
    {
      "type": "file",
      "provider": "drive",
      "id": "DEST_FILE_ID",
      "file_type": "gsheets",
      "sheet_name": "Sales copy"
    }
  ]
}

Details of every field: AutomationCreate. Column fields in a request are spreadsheet letters, never header names. 3. POST /rest/beta/automations/{id}/run starts a run. 200 means the run was enqueued, not finished. 4. GET /rest/beta/automations/{id}/run returns the last run. Repeat it until execution is not running; then read result.

Endpoints

workflows

Page: https://dev-api.sheetgo.com/rest/reference/workflows.md

automations

Page: https://dev-api.sheetgo.com/rest/reference/automations.md

triggers

Page: https://dev-api.sheetgo.com/rest/reference/triggers.md

dashboards

Page: https://dev-api.sheetgo.com/rest/reference/dashboards.md

forms

Page: https://dev-api.sheetgo.com/rest/reference/forms.md

webhook

Page: https://dev-api.sheetgo.com/rest/reference/webhook.md

api-destination

Page: https://dev-api.sheetgo.com/rest/reference/api-destination.md

integrations

Page: https://dev-api.sheetgo.com/rest/reference/integrations.md

outlook

Page: https://dev-api.sheetgo.com/rest/reference/outlook.md

gmail

Page: https://dev-api.sheetgo.com/rest/reference/gmail.md

files

Page: https://dev-api.sheetgo.com/rest/reference/files.md

bigquery

Page: https://dev-api.sheetgo.com/rest/reference/bigquery.md

auth

Page: https://dev-api.sheetgo.com/rest/reference/auth.md

Guides

More: start page https://dev-api.sheetgo.com/rest/reference.md, everything in one file https://dev-api.sheetgo.com/rest/llms-full.txt, OpenAPI https://dev-api.sheetgo.com/rest/openapi.json.