Integrations

Developers › REST API › Forms & Integrations

REST API · 2 endpoints

Complete for this group. Each operation below lists its parameters, request body, responses and errors. Every model they use is documented under Models used on this page, so you do not need another page to build a request. Base URL https://api.sheetgo.com; paths are complete, version included (/rest/beta/…): append them to the base URL exactly as shown; send Authorization: Bearer sg_…. Also in the API's own docs: https://api.sheetgo.com/rest/reference/integrations (Markdown).

Conventions for every endpoint. Lists take page (from 1) and per_page (1-100, default 50), and total counts pages, not items. Collection URLs end with /. POST …/run returns 200 when the run is queued; poll GET …/run. Google Sheets use provider: "drive"; column fields take letters ("E"). Error bodies and status codes: REST API › Errors.

Python recipes. API client helper.

Integrations are pre-configured sources for third-party services — currently Shopify and QuickBooks. Instead of describing an HTTP request yourself, you pick a data source from a menu and Sheetgo supplies the URL, credentials, pagination and response parsing for the account you authorized.

Use GET /rest/beta/integrations to see which providers you have connected and under which accounts, and GET /rest/beta/integrations/{provider}/options to list the data sources you can pull and the parameters each accepts. Then create an automation with an integration source.

Authorizing a provider is a browser sign-in in the Sheetgo web app and cannot be done through the API — these endpoints report the result.

Operations

GET/rest/beta/integrationsList integrations and connected accounts

Every integration, whether or not you have authorized it.

accounts[].account is what an automation's sources[].account expects. With exactly one account for a provider you can omit that field and Sheetgo resolves it; with several, naming one is required.

Authorization itself happens in the Sheetgo web app — it is a browser OAuth flow and cannot be driven from an API key.

Responses

Status	Meaning	Body
200	Providers and your authorized accounts	`IntegrationListResponse`
401	Authentication failed or token is invalid	—

Example request

curl -s -X GET "https://api.sheetgo.com/rest/beta/integrations" \
  -H "Authorization: Bearer $SHEETGO_API_KEY"

In the API's own docs: https://api.sheetgo.com/rest/reference/integrations#get-rest-beta-integrations

GET/rest/beta/integrations/{provider}/optionsList a provider's data sources

What you can ask this provider for.

Static per provider and identical for every account, so this answers even before you have authorized one — useful for exploring first. id is what sources[].data_source expects; parameters is what sources[].parameters accepts, and only QuickBooks reports declare any.

Retired data sources are omitted: they would raise mid-run rather than return data.

Parameters

Name	In	Type		Description
`provider`	path	`IntegrationProvider`	required	Integration provider: shopify or quickbooks

Responses

Status	Meaning	Body
200	Selectable data sources	`IntegrationOptionsResponse`
401	Authentication failed or token is invalid	—
422	Validation Error	`HTTPValidationError`

Example request

curl -s -X GET "https://api.sheetgo.com/rest/beta/integrations/PROVIDER/options" \
  -H "Authorization: Bearer $SHEETGO_API_KEY"

In the API's own docs: https://api.sheetgo.com/rest/reference/integrations#get-rest-beta-integrations-provider-options

Models used on this page

Every request and response model referenced above, including nested ones (9). The full catalogue is on the Models page.

`DataSourceOut`

One thing you can ask a provider for.

Field	Type		Description
`description`	string	optional	What it returns Default: `""`
`id`	string	required	Pass this back as `sources[].data_source`
`kind`	string	required	`query` for records, `report` for a report
`name`	string	required	Display name
`parameters`	object (map of string → `DataSourceParameter`)	optional	Parameters this data source accepts, keyed by name. Empty for everything except QuickBooks reports.

`DataSourceParameter`

One parameter a data source accepts.

When options is present it is the authority: date_macro declares type: date but its options are macro strings like "Last Month", so a value is checked against options first and against type only when no options are declared.

Field	Type		Description
`description`	string	nullable	What it controls
`format`	string	nullable	Expected format when the type is `date`
`name`	string	nullable	Display name
`optional_for`	array of string	nullable	Advisory: supplying this parameter makes those alternatives unnecessary. Nothing is enforced as required.
`options`	array of string	nullable	Accepted values. When present, the only accepted values.
`type`	string	nullable	`date` or `string`

`HTTPValidationError`

Field	Type		Description
`detail`	array of `ValidationError`	optional

`IntegrationAccount`

One authorized account for a provider.

Field	Type		Description
`account`	string	required	Pass this back as `sources[].account`. The shop domain for Shopify, the realm (company) id for QuickBooks.
`connected_at`	string (date-time)	nullable	When the account was authorized
`may_be_revoked`	boolean	optional	True when the stored credentials are gone — the account must be re-authorized in the web app before it will run. Default: `false`

`IntegrationListResponse`

Standard envelope. The provider list is fixed and short, so there are no paging query params -- same as GET /rest/beta/files/{provider}/roots.

Field	Type		Description
`page`	integer	nullable	Page number Default: `1`
`per_page`	integer	nullable	Number of items per page Default: `50`
`results`	array of `IntegrationOut`	optional	List of results
`total`	integer	nullable	Total number of pages Default: `0`

Used by: GET /rest/beta/integrations

`IntegrationOptionsResponse`

Everything selectable for one provider.

Field	Type		Description
`data_sources`	array of `DataSourceOut`	optional	Every data source this provider exposes. Use a `key` from here as an integration source's `data_source`.
`provider`	string	required	The provider these options belong to, e.g. `shopify` or `quickbooks`.

Used by: GET /rest/beta/integrations/{provider}/options

`IntegrationOut`

One provider, with whatever the caller has authorized for it.

Field	Type		Description
`accounts`	array of `IntegrationAccount`	optional	Authorized accounts. Empty when not connected — authorization happens in the Sheetgo web app, not here.
`connected`	boolean	required	True when at least one account is authorized
`name`	string	required	Display name
`provider`	string	required	Pass this back as `sources[].provider`

`IntegrationProvider`

Third-party services with a pre-configured, server-managed API source.

Distinct from Provider, which lists storage backends. The value is also the prefix of the compound service_origin a compiled source carries (shopify:<shop>), which is what makes core-lib's load_provider_manager pick the provider-specific request manager.

Type: one of "shopify", "quickbooks"

Used by: GET /rest/beta/integrations/{provider}/options

`ValidationError`

Field	Type
`loc`	array of string or integer	required
`msg`	string	required
`type`	string	required