Google Sheets

Connect to Google Sheets. Create, edit, and analyze spreadsheets with powerful data management capabilities

Supports authentication: OAuth 2.0

Usage

Connect a user’s Google Sheets account and make API calls on their behalf — Scalekit handles OAuth and token management automatically.

You can interact with Google Sheets in two ways — via direct proxy API calls or via Scalekit optimized tool calls. Scroll down to see the list of available Scalekit tools.

1
import { ScalekitClient } from '@scalekit-sdk/node';
2
import 'dotenv/config';
3

4
const connectionName = 'google_sheets'; // get your connection name from connection configurations
5
const identifier = 'user_123';          // your unique user identifier
6

7
// Get your credentials from app.scalekit.com → Developers → Settings → API Credentials
8
const scalekit = new ScalekitClient(
9
  process.env.SCALEKIT_ENV_URL,
10
  process.env.SCALEKIT_CLIENT_ID,
11
  process.env.SCALEKIT_CLIENT_SECRET
12
);
13
const actions = scalekit.actions;
14

15
// Authenticate the user
16
const { link } = await actions.getAuthorizationLink({
17
  connectionName,
18
  identifier,
19
});
20
console.log('🔗 Authorize Google Sheets:', link); // present this link to your user for authorization, or click it yourself for testing
21
process.stdout.write('Press Enter after authorizing...');
22
await new Promise(r => process.stdin.once('data', r));
23

24
// Make a request via Scalekit proxy
25
const result = await actions.request({
26
  connectionName,
27
  identifier,
28
  path: '/v4/spreadsheets',
29
  method: 'GET',
30
});
31
console.log(result);

1
import scalekit.client, os
2
from dotenv import load_dotenv
3
load_dotenv()
4

5
connection_name = "google_sheets"  # get your connection name from connection configurations
6
identifier = "user_123"            # your unique user identifier
7

8
# Get your credentials from app.scalekit.com → Developers → Settings → API Credentials
9
scalekit_client = scalekit.client.ScalekitClient(
10
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
11
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
12
    env_url=os.getenv("SCALEKIT_ENV_URL"),
13
)
14
actions = scalekit_client.actions
15

16
# Authenticate the user
17
link_response = actions.get_authorization_link(
18
    connection_name=connection_name,
19
    identifier=identifier
20
)
21
# present this link to your user for authorization, or click it yourself for testing
22
print("🔗 Authorize Google Sheets:", link_response.link)
23
input("Press Enter after authorizing...")
24

25
# Make a request via Scalekit proxy
26
result = actions.request(
27
    connection_name=connection_name,
28
    identifier=identifier,
29
    path="/v4/spreadsheets",
30
    method="GET"
31
)
32
print(result)

Scalekit Tools

`googlesheets_create_spreadsheet`

Create a new Google Sheets spreadsheet with an optional title and initial sheet configuration. Returns the new spreadsheet ID and metadata.

Name	Type	Required	Description
`locale`	string	No	Locale of the spreadsheet
`schema_version`	string	No	Optional schema version to use for tool execution
`sheets`	`array<object>`	No	Initial sheets to include in the spreadsheet
`time_zone`	string	No	Time zone for the spreadsheet
`title`	string	No	Title of the new spreadsheet
`tool_version`	string	No	Optional tool version to use for execution

`googlesheets_get_values`

Returns only the cell values from a specific range in a Google Sheet — no metadata, no formatting, just the data. For full spreadsheet metadata and formatting, use googlesheets_read_spreadsheet instead.

Name	Type	Required	Description
`major_dimension`	string	No	Whether values are returned by rows or columns
`range`	string	Yes	Cell range to read in A1 notation
`schema_version`	string	No	Optional schema version to use for tool execution
`spreadsheet_id`	string	Yes	The ID of the Google Sheet
`tool_version`	string	No	Optional tool version to use for execution
`value_render_option`	string	No	How values should be rendered in the response

`googlesheets_read_spreadsheet`

Returns everything about a spreadsheet — including spreadsheet metadata, sheet properties, cell values, formatting, themes, and pixel sizes. If you only need cell values, use googlesheets_get_values instead.

Name	Type	Required	Description
`include_grid_data`	boolean	No	Include cell data in the response
`ranges`	string	No	Cell range to read in A1 notation
`schema_version`	string	No	Optional schema version to use for tool execution
`spreadsheet_id`	string	Yes	The ID of the Google Sheet to read
`tool_version`	string	No	Optional tool version to use for execution

`googlesheets_update_values`

Update cell values in a specific range of a Google Sheet. Supports writing single cells or multiple rows and columns at once.

Name	Type	Required	Description
`include_values_in_response`	boolean	No	Return the updated cell values in the response
`range`	string	Yes	Cell range to update in A1 notation
`schema_version`	string	No	Optional schema version to use for tool execution
`spreadsheet_id`	string	Yes	The ID of the Google Sheet to update
`tool_version`	string	No	Optional tool version to use for execution
`value_input_option`	string	No	How input values should be interpreted
`values`	`array<array>`	Yes	2D array of values to write to the range

Tool list