---
title: "Google Sheets Check"
method: POST
path: "/integrations/google-sheets/check"
tags: ["Google Sheets"]
---

# Google Sheets Check

`POST /integrations/google-sheets/check`

## Request

- Base URL: `https://api.openintake.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.openintake.ai/integrations/google-sheets/check`
- Auth: none declared
- TypeScript: <https://skmtc.dev/openintake/apis/openintake-api/docs/integrations/google-sheets/check/post.ts> (a function with typed inputs; its response is checked against the schema)

Open the spreadsheet as the signed-in account and show how row 1 maps
to lead fields. Reads only; nothing is saved or written.

## Request body

- GoogleSheetsCheckRequest: Check access without saving. Omitted fields use the saved settings.
  - `spreadsheet` string, nullable
  - `sheet_name` string, nullable

## Response `200`

Successful Response

- GoogleSheetsCheckResponse: What the signed-in account can see of the spreadsheet.
  - `account_email` string, nullable
  - `spreadsheet_id` string, required
  - `spreadsheet_title` string, nullable
  - `spreadsheet_url` string, required
  - `sheets` string[], required
  - `sheet_name` string, nullable
  - `columns` GoogleSheetsColumn[]
    - `header` string, required
    - `field` string, nullable
  - `matched_columns` integer
  - `lead_fields` GoogleSheetsLeadField[]
    - `key` string, required
    - `headers` string[], required

## Other responses

- `422`: Validation Error

## Changes

- **2026-11-03** `56ef656004f6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/openintake/apis/openintake-api/changes/integrations/google-sheets/check/post.md)

---

[API](https://skmtc.dev/openintake/apis/openintake-api.md) - [All operations](https://skmtc.dev/openintake/apis/openintake-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openintake/apis/openintake-api/revisions/fe9f779e77ad?raw)