# Sheetgo API

> Public REST API of Sheetgo to manage workflows, automations and forms and to read their data. Fetch the start page first; it lists every endpoint. Base URL: https://dev-api.sheetgo.com. Send `Authorization: Bearer sg_…` with every request.

Fetch the start page, then the group page of the endpoint you need and every model page it links; do not guess fields not shown in these pages.

## Start

- [Start page](https://dev-api.sheetgo.com/rest/reference.md): read this first; it lists every endpoint and how to read the docs.
- [Full documentation in one file](https://dev-api.sheetgo.com/rest/llms-full.txt): the start page and every other page concatenated.

## Endpoints

- [workflows](https://dev-api.sheetgo.com/rest/reference/workflows.md): A **workflow** is an automated process that connects your spreadsheets and files and moves data...
- [automations](https://dev-api.sheetgo.com/rest/reference/automations.md): An **automation** (also called a *connection*) is a single data transfer inside a workflow: it...
- [triggers](https://dev-api.sheetgo.com/rest/reference/triggers.md): A **trigger** defines what makes a workflow run **automatically**, so you set it once instead of...
- [dashboards](https://dev-api.sheetgo.com/rest/reference/dashboards.md): **Dashboards** turn a workflow's data into shareable visual summaries. Each workflow has a single...
- [forms](https://dev-api.sheetgo.com/rest/reference/forms.md): A **Sheetgo form** collects data straight into a workflow. Its fields come from your...
- [webhook](https://dev-api.sheetgo.com/rest/reference/webhook.md): A **webhook** is a private URL that lets external systems push data into a workflow over HTTP....
- [api-destination](https://dev-api.sheetgo.com/rest/reference/api-destination.md): **API as a destination** turns a workflow's output into a live, read-only JSON feed at a private...
- [integrations](https://dev-api.sheetgo.com/rest/reference/integrations.md): **Integrations** are pre-configured sources for third-party services — currently Shopify and...
- [outlook](https://dev-api.sheetgo.com/rest/reference/outlook.md): Integration endpoints used by the Sheetgo add-in for Microsoft Outlook to connect mailbox data to...
- [gmail](https://dev-api.sheetgo.com/rest/reference/gmail.md): Send email through a connected Google account.
- [files](https://dev-api.sheetgo.com/rest/reference/files.md): Browse and search the storage providers connected to your account — **Google Drive**...
- [bigquery](https://dev-api.sheetgo.com/rest/reference/bigquery.md): **BigQuery** can be both a source and a destination for an automation: read a table or a query's...
- [auth](https://dev-api.sheetgo.com/rest/reference/auth.md): OAuth2 authorization endpoints — exchange a `Client ID` / `Client Secret` for an access token...

## Guides

- [Rate Limiting](https://dev-api.sheetgo.com/rest/guides/rate-limiting.md): To keep the platform fast and fair, the API limits how many requests each account can make in a...
- [API Key Scopes](https://dev-api.sheetgo.com/rest/guides/api-key-scopes.md): Sheetgo API keys let apps, scripts, and AI agents act on your Sheetgo account. By default a key...
- [Smart Tags](https://dev-api.sheetgo.com/rest/guides/smart-tags.md): A **smart tag** is a `{{placeholder}}` that Sheetgo replaces with a value from your data while an...
- [Cell References](https://dev-api.sheetgo.com/rest/guides/cell-references.md): A **cell reference** is a `{{Tab!Ref}}` placeholder you put inside an `api` source's request....

## Models

- [AIProcessor](https://dev-api.sheetgo.com/rest/reference/models/AIProcessor.md)
- [AnonymizeMethod](https://dev-api.sheetgo.com/rest/reference/models/AnonymizeMethod.md): The web app's masking methods (core-lib v1/dataframe/anonymizer.py).
- [AnonymizeMode](https://dev-api.sheetgo.com/rest/reference/models/AnonymizeMode.md): `automatic`: Google DLP (Sheetgo's project) detects personal data and hashes it.
- [AnonymizeProcessor](https://dev-api.sheetgo.com/rest/reference/models/AnonymizeProcessor.md): Mask personal data before it reaches the destination (the web app's Anonymize step).
- [AttachmentIn](https://dev-api.sheetgo.com/rest/reference/models/AttachmentIn.md)
- [AuthConfigIn](https://dev-api.sheetgo.com/rest/reference/models/AuthConfigIn.md): Access restriction.
- [AutomationCreate](https://dev-api.sheetgo.com/rest/reference/models/AutomationCreate.md)
- [AutomationModel](https://dev-api.sheetgo.com/rest/reference/models/AutomationModel.md)
- [AutomationPatch](https://dev-api.sheetgo.com/rest/reference/models/AutomationPatch.md): Rename only.
- [AutomationReplace](https://dev-api.sheetgo.com/rest/reference/models/AutomationReplace.md)
- [AutomationRunStatus](https://dev-api.sheetgo.com/rest/reference/models/AutomationRunStatus.md): The outcome of an automation's LAST run.
- [BatchBody](https://dev-api.sheetgo.com/rest/reference/models/BatchBody.md): Fetch several messages in one request, by id.
- [BigQueryDataset](https://dev-api.sheetgo.com/rest/reference/models/BigQueryDataset.md)
- [BigQueryDatasetListResponse](https://dev-api.sheetgo.com/rest/reference/models/BigQueryDatasetListResponse.md)
- [BigQueryPartition](https://dev-api.sheetgo.com/rest/reference/models/BigQueryPartition.md): Partitioning for a table Sheetgo creates.
- [BigQueryPartitionGranularity](https://dev-api.sheetgo.com/rest/reference/models/BigQueryPartitionGranularity.md)
- [BigQueryPartitioningInfo](https://dev-api.sheetgo.com/rest/reference/models/BigQueryPartitioningInfo.md): How an existing table is partitioned.
- [BigQueryProject](https://dev-api.sheetgo.com/rest/reference/models/BigQueryProject.md): One GCP project visible to the authorized account.
- [BigQueryProjectListResponse](https://dev-api.sheetgo.com/rest/reference/models/BigQueryProjectListResponse.md)
- [BigQueryTable](https://dev-api.sheetgo.com/rest/reference/models/BigQueryTable.md)
- [BigQueryTableDetail](https://dev-api.sheetgo.com/rest/reference/models/BigQueryTableDetail.md): One table, with the typed schema a destination's `partition.field` needs.
- [BigQueryTableListResponse](https://dev-api.sheetgo.com/rest/reference/models/BigQueryTableListResponse.md)
- [BigQueryWriteMode](https://dev-api.sheetgo.com/rest/reference/models/BigQueryWriteMode.md): What happens to data already in the destination table.
- [BodyContent](https://dev-api.sheetgo.com/rest/reference/models/BodyContent.md)
- [Body_auth_token_rest_auth_token_post](https://dev-api.sheetgo.com/rest/reference/models/Body_auth_token_rest_auth_token_post.md)
- [ChangeOwnerIn](https://dev-api.sheetgo.com/rest/reference/models/ChangeOwnerIn.md)
- [ChartItem](https://dev-api.sheetgo.com/rest/reference/models/ChartItem.md): One chart already drawn in the spreadsheet.
- [CollaboratorOut](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorOut.md)
- [CollaboratorRoleUpdate](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorRoleUpdate.md)
- [CollaboratorsAdd](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsAdd.md)
- [CollaboratorsOut](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsOut.md)
- [ColumnItem](https://dev-api.sheetgo.com/rest/reference/models/ColumnItem.md): One column of a tab's header row.
- [ConditionExpression](https://dev-api.sheetgo.com/rest/reference/models/ConditionExpression.md)
- [ConditionType](https://dev-api.sheetgo.com/rest/reference/models/ConditionType.md)
- [ContentType](https://dev-api.sheetgo.com/rest/reference/models/ContentType.md): What a folder source reads: spreadsheets, or documents for AI extraction.
- [DashboardOut](https://dev-api.sheetgo.com/rest/reference/models/DashboardOut.md): A workflow's single dashboard: its elements and its publication state.
- [DataSourceOut](https://dev-api.sheetgo.com/rest/reference/models/DataSourceOut.md): One thing you can ask a provider for.
- [DataSourceParameter](https://dev-api.sheetgo.com/rest/reference/models/DataSourceParameter.md): One parameter a data source accepts.
- [DestinationApiPublish](https://dev-api.sheetgo.com/rest/reference/models/DestinationApiPublish.md): Publish the automation's rows to a Sheetgo-hosted endpoint you can poll.
- [DestinationBigQuery-Input](https://dev-api.sheetgo.com/rest/reference/models/DestinationBigQuery-Input.md): Load the automation's rows into a BigQuery table.
- [DestinationBigQuery-Output](https://dev-api.sheetgo.com/rest/reference/models/DestinationBigQuery-Output.md): Load the automation's rows into a BigQuery table.
- [DestinationDocument](https://dev-api.sheetgo.com/rest/reference/models/DestinationDocument.md): Generate one Google Docs file per row from a template (docs-merge).
- [DestinationFile](https://dev-api.sheetgo.com/rest/reference/models/DestinationFile.md)
- [DestinationFolder](https://dev-api.sheetgo.com/rest/reference/models/DestinationFolder.md)
- [DestinationMailMerge](https://dev-api.sheetgo.com/rest/reference/models/DestinationMailMerge.md): Send one personalized email per row, rendered from `body`.
- [DestinationPDF](https://dev-api.sheetgo.com/rest/reference/models/DestinationPDF.md): Export the automation's output to PDF into a Drive folder (converter).
- [DestinationShare](https://dev-api.sheetgo.com/rest/reference/models/DestinationShare.md): Email the files this automation produced.
- [DestinationWebhook](https://dev-api.sheetgo.com/rest/reference/models/DestinationWebhook.md): POST the automation's rows to an endpoint you own.
- [ElementDataOut](https://dev-api.sheetgo.com/rest/reference/models/ElementDataOut.md): One element's current values.
- [ElementOut](https://dev-api.sheetgo.com/rest/reference/models/ElementOut.md): One stored element, in public vocabulary.
- [ElementType](https://dev-api.sheetgo.com/rest/reference/models/ElementType.md)
- [EmailFilter-Input](https://dev-api.sheetgo.com/rest/reference/models/EmailFilter-Input.md): Which emails an Outlook source reads.
- [EmailFilter-Output](https://dev-api.sheetgo.com/rest/reference/models/EmailFilter-Output.md): Which emails an Outlook source reads.
- [EmailFilterRule](https://dev-api.sheetgo.com/rest/reference/models/EmailFilterRule.md): One condition of an Outlook source's `email_filter`.
- [ExchangedToken](https://dev-api.sheetgo.com/rest/reference/models/ExchangedToken.md): The token pair returned by the OAuth2 token and refresh endpoints.
- [ExecutionStatus](https://dev-api.sheetgo.com/rest/reference/models/ExecutionStatus.md)
- [ExpressionCriteria](https://dev-api.sheetgo.com/rest/reference/models/ExpressionCriteria.md)
- [FileAccessRole](https://dev-api.sheetgo.com/rest/reference/models/FileAccessRole.md)
- [FileFilter-Input](https://dev-api.sheetgo.com/rest/reference/models/FileFilter-Input.md): Which files inside a folder source are read.
- [FileFilter-Output](https://dev-api.sheetgo.com/rest/reference/models/FileFilter-Output.md): Which files inside a folder source are read.
- [FileFilterRule](https://dev-api.sheetgo.com/rest/reference/models/FileFilterRule.md): One condition of a folder source's `file_filter`.
- [FileItem](https://dev-api.sheetgo.com/rest/reference/models/FileItem.md): One file or folder, normalized across all four storage providers.
- [FileListResponse](https://dev-api.sheetgo.com/rest/reference/models/FileListResponse.md): Standard paginated envelope plus a truncation flag.
- [FileSendingMethod](https://dev-api.sheetgo.com/rest/reference/models/FileSendingMethod.md): How the files reach the recipient.
- [FileStructureResponse](https://dev-api.sheetgo.com/rest/reference/models/FileStructureResponse.md): What is inside one file.
- [FileType](https://dev-api.sheetgo.com/rest/reference/models/FileType.md)
- [FileTypeFilter](https://dev-api.sheetgo.com/rest/reference/models/FileTypeFilter.md): Public ``type`` vocabulary.
- [FilterColumn](https://dev-api.sheetgo.com/rest/reference/models/FilterColumn.md)
- [FilterCondition-Input](https://dev-api.sheetgo.com/rest/reference/models/FilterCondition-Input.md)
- [FilterCondition-Output](https://dev-api.sheetgo.com/rest/reference/models/FilterCondition-Output.md)
- [FilterQuery](https://dev-api.sheetgo.com/rest/reference/models/FilterQuery.md)
- [FormCreate](https://dev-api.sheetgo.com/rest/reference/models/FormCreate.md): Form creation data
- [FormFile](https://dev-api.sheetgo.com/rest/reference/models/FormFile.md): Used in form creation and update
- [FormFileModel](https://dev-api.sheetgo.com/rest/reference/models/FormFileModel.md): For displaying data
- [FormModel](https://dev-api.sheetgo.com/rest/reference/models/FormModel.md): For displaying data
- [FormPatch](https://dev-api.sheetgo.com/rest/reference/models/FormPatch.md): Form update data
- [FormSubmissionTriggerIn](https://dev-api.sheetgo.com/rest/reference/models/FormSubmissionTriggerIn.md): Run this workflow whenever a bound Sheetgo form receives a new response.
- [GeneralAccessOut](https://dev-api.sheetgo.com/rest/reference/models/GeneralAccessOut.md)
- [GeneralAccessSet](https://dev-api.sheetgo.com/rest/reference/models/GeneralAccessSet.md)
- [GmailSendBody](https://dev-api.sheetgo.com/rest/reference/models/GmailSendBody.md): One message to send through the authorized Gmail account.
- [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)
- [IdentifyDataType](https://dev-api.sheetgo.com/rest/reference/models/IdentifyDataType.md)
- [ImportMode](https://dev-api.sheetgo.com/rest/reference/models/ImportMode.md): Which files a folder source imports, ordered by modified time.
- [IntegrationAccount](https://dev-api.sheetgo.com/rest/reference/models/IntegrationAccount.md): One authorized account for a provider.
- [IntegrationListResponse](https://dev-api.sheetgo.com/rest/reference/models/IntegrationListResponse.md): Standard envelope.
- [IntegrationOptionsResponse](https://dev-api.sheetgo.com/rest/reference/models/IntegrationOptionsResponse.md): Everything selectable for one provider.
- [IntegrationOut](https://dev-api.sheetgo.com/rest/reference/models/IntegrationOut.md): One provider, with whatever the caller has authorized for it.
- [IntegrationProvider](https://dev-api.sheetgo.com/rest/reference/models/IntegrationProvider.md): Third-party services with a pre-configured, server-managed API source.
- [ItemKind](https://dev-api.sheetgo.com/rest/reference/models/ItemKind.md): What a result *is*, beyond its file type.
- [KeepDuplicateType](https://dev-api.sheetgo.com/rest/reference/models/KeepDuplicateType.md)
- [LeftJoinProcessor](https://dev-api.sheetgo.com/rest/reference/models/LeftJoinProcessor.md)
- [MergeProcessor](https://dev-api.sheetgo.com/rest/reference/models/MergeProcessor.md)
- [ModelSettings](https://dev-api.sheetgo.com/rest/reference/models/ModelSettings.md): OpenAI settings the AI step passes to the model.
- [NamedRangeItem](https://dev-api.sheetgo.com/rest/reference/models/NamedRangeItem.md): One named range.
- [OnProcessingError](https://dev-api.sheetgo.com/rest/reference/models/OnProcessingError.md): What a documents run does when one document cannot be read.
- [OutlookAccount](https://dev-api.sheetgo.com/rest/reference/models/OutlookAccount.md): Which connected Microsoft account reads the mailbox.
- [OutlookExtract](https://dev-api.sheetgo.com/rest/reference/models/OutlookExtract.md)
- [OutlookMailbox](https://dev-api.sheetgo.com/rest/reference/models/OutlookMailbox.md): The mailbox folder to read — the three the web app offers.
- [PageOrientation](https://dev-api.sheetgo.com/rest/reference/models/PageOrientation.md)
- [PaginatedResponse](https://dev-api.sheetgo.com/rest/reference/models/PaginatedResponse.md)
- [PaginatedResponse_AutomationModel_](https://dev-api.sheetgo.com/rest/reference/models/PaginatedResponse_AutomationModel_.md)
- [PaginatedResponse_FormModel_](https://dev-api.sheetgo.com/rest/reference/models/PaginatedResponse_FormModel_.md)
- [PaginatedResponse_WorkflowModel_](https://dev-api.sheetgo.com/rest/reference/models/PaginatedResponse_WorkflowModel_.md)
- [PaginationCursor](https://dev-api.sheetgo.com/rest/reference/models/PaginationCursor.md): Follow a cursor until the response says there is no more.
- [PaginationHeaderLink](https://dev-api.sheetgo.com/rest/reference/models/PaginationHeaderLink.md): Follow a next-page link found in a response header (e.g.
- [PaginationLink](https://dev-api.sheetgo.com/rest/reference/models/PaginationLink.md): Follow a next-page link found in the response body.
- [PaginationOffset](https://dev-api.sheetgo.com/rest/reference/models/PaginationOffset.md): Advance an offset by the limit until a short page comes back.
- [PaginationPage](https://dev-api.sheetgo.com/rest/reference/models/PaginationPage.md): Increment a page number until a short page comes back.
- [PaginationQueryOffset](https://dev-api.sheetgo.com/rest/reference/models/PaginationQueryOffset.md): Rewrite offset/limit keywords inside a SQL-like query parameter.
- [PaperSize](https://dev-api.sheetgo.com/rest/reference/models/PaperSize.md)
- [Provider](https://dev-api.sheetgo.com/rest/reference/models/Provider.md)
- [PublishOut](https://dev-api.sheetgo.com/rest/reference/models/PublishOut.md): The dashboard's current publication state.
- [RefreshTokenRequest](https://dev-api.sheetgo.com/rest/reference/models/RefreshTokenRequest.md): The parameters used when refreshing a token
- [RemoveDuplicatesProcessor](https://dev-api.sheetgo.com/rest/reference/models/RemoveDuplicatesProcessor.md)
- [ResolvedFile](https://dev-api.sheetgo.com/rest/reference/models/ResolvedFile.md): The spreadsheet a folder id resolved to.
- [SendBody](https://dev-api.sheetgo.com/rest/reference/models/SendBody.md): One message to send through the authorized Outlook account.
- [SendFrom](https://dev-api.sheetgo.com/rest/reference/models/SendFrom.md): Which mailbox sends an email destination's messages.
- [SourceAPI](https://dev-api.sheetgo.com/rest/reference/models/SourceAPI.md): Request an HTTP endpoint and use the JSON it returns as source data.
- [SourceAllTabs](https://dev-api.sheetgo.com/rest/reference/models/SourceAllTabs.md)
- [SourceAuth](https://dev-api.sheetgo.com/rest/reference/models/SourceAuth.md): OAuth2 refresh for an API source.
- [SourceBigQuery](https://dev-api.sheetgo.com/rest/reference/models/SourceBigQuery.md): Read a BigQuery table, or the results of a query over it.
- [SourceFile](https://dev-api.sheetgo.com/rest/reference/models/SourceFile.md)
- [SourceFolder-Input](https://dev-api.sheetgo.com/rest/reference/models/SourceFolder-Input.md)
- [SourceFolder-Output](https://dev-api.sheetgo.com/rest/reference/models/SourceFolder-Output.md)
- [SourceIntegration](https://dev-api.sheetgo.com/rest/reference/models/SourceIntegration.md): A pre-configured third-party source (Shopify, QuickBooks).
- [SourceOutlook-Input](https://dev-api.sheetgo.com/rest/reference/models/SourceOutlook-Input.md): Read emails from an Outlook mailbox folder and save their file attachments (or bodies as HTML) into one existing folder destination.
- [SourceOutlook-Output](https://dev-api.sheetgo.com/rest/reference/models/SourceOutlook-Output.md): Read emails from an Outlook mailbox folder and save their file attachments (or bodies as HTML) into one existing folder destination.
- [SourceWebhook](https://dev-api.sheetgo.com/rest/reference/models/SourceWebhook.md)
- [Split](https://dev-api.sheetgo.com/rest/reference/models/Split.md)
- [SpreadsheetStructure](https://dev-api.sheetgo.com/rest/reference/models/SpreadsheetStructure.md): Spreadsheet body of a structure response.
- [SuccessResponse](https://dev-api.sheetgo.com/rest/reference/models/SuccessResponse.md): The legacy success envelope, returned by the pre-existing CRUD routes.
- [TabItem](https://dev-api.sheetgo.com/rest/reference/models/TabItem.md): One tab (sheet) of a spreadsheet.
- [TimeTriggerIn](https://dev-api.sheetgo.com/rest/reference/models/TimeTriggerIn.md): Time/smart schedule.
- [TriggerOut](https://dev-api.sheetgo.com/rest/reference/models/TriggerOut.md): Read model echoed by GET and returned by PUT.
- [UnusedFields](https://dev-api.sheetgo.com/rest/reference/models/UnusedFields.md): What happens to a `{{Tag}}` in the template that no source column matches.
- [ValidateQueryRequest](https://dev-api.sheetgo.com/rest/reference/models/ValidateQueryRequest.md)
- [ValidateQueryResponse](https://dev-api.sheetgo.com/rest/reference/models/ValidateQueryResponse.md): The dry run's verdict.
- [ValidationError](https://dev-api.sheetgo.com/rest/reference/models/ValidationError.md)
- [WebhookBody](https://dev-api.sheetgo.com/rest/reference/models/WebhookBody.md)
- [WebhookOut](https://dev-api.sheetgo.com/rest/reference/models/WebhookOut.md): A webhook endpoint bound to one automation's webhook source.
- [WorkflowArchive](https://dev-api.sheetgo.com/rest/reference/models/WorkflowArchive.md): Workflow archive
- [WorkflowAutomationModel](https://dev-api.sheetgo.com/rest/reference/models/WorkflowAutomationModel.md)
- [WorkflowCreate](https://dev-api.sheetgo.com/rest/reference/models/WorkflowCreate.md): New workflow creation
- [WorkflowFinishedTriggerIn](https://dev-api.sheetgo.com/rest/reference/models/WorkflowFinishedTriggerIn.md): Run this workflow when another workflow finishes.
- [WorkflowModel](https://dev-api.sheetgo.com/rest/reference/models/WorkflowModel.md): Data presentation model for Workflow
- [WorkflowPatch](https://dev-api.sheetgo.com/rest/reference/models/WorkflowPatch.md): Workflow patch
- [WorkflowRunStatus](https://dev-api.sheetgo.com/rest/reference/models/WorkflowRunStatus.md): The outcome of a workflow's LAST run, plus one entry per automation.

## Optional

- [OpenAPI specification](https://dev-api.sheetgo.com/rest/openapi.json): raw machine-readable spec.
- [Swagger UI (interactive, needs JavaScript)](https://dev-api.sheetgo.com/rest): browsable reference for people.