Google Sheets website screenshot

Google Sheets

API for reading, writing, and formatting data in Google Sheets.

2 APIs 10 Features
Google WorkspaceProductivitySpreadsheets

APIs

Google Sheets API v4

The Google Sheets API lets you read, write, and format Google Sheets data.

Google Apps Script Spreadsheet Service

The built-in Google Apps Script Spreadsheet Service allows creation, access, and modification of Google Sheets files directly from Apps Script with performance bundling and nume...

Collections

Arazzo Workflows

Google Sheets Append Rows and Format the Header

Create a spreadsheet, append rows including a header, then bold the header row via batchUpdate.

ARAZZO

Google Sheets Archive and Clear Multiple Ranges

Read several ranges as an archive, clear them all in one batch, then re-read to confirm they are empty.

ARAZZO

Google Sheets Bulk Load Multiple Ranges

Create a spreadsheet, write several ranges in one batch, then read them all back in one batch.

ARAZZO

Google Sheets Copy a Sheet Between Spreadsheets

Read a source spreadsheet, copy one of its sheets into a destination spreadsheet, then confirm the destination.

ARAZZO

Google Sheets Create and Seed a Spreadsheet

Create a new spreadsheet, append seed rows to it, then read them back.

ARAZZO

Google Sheets Create With an Extra Sheet and Write

Create a spreadsheet, add a second named sheet to it, then write values into that sheet.

ARAZZO

Google Sheets Create, Write, and Verify

Create a spreadsheet, write values into a range, then read the range back to verify the write.

ARAZZO

Google Sheets Overwrite or Append Rows

Inspect a range and branch — overwrite it in place when it already has data, otherwise append fresh rows.

ARAZZO

Google Sheets Refresh a Range

Read the current values of a range, clear it, then write a fresh set of values into it.

ARAZZO

Google Sheets Seed a Range Only If Empty

Read a range and branch — write seed values only when the range has no existing data.

ARAZZO

Google Sheets Tag and Find a Spreadsheet With Developer Metadata

Create a spreadsheet, attach a developer metadata tag via batchUpdate, then search for it by key.

ARAZZO

Google Sheets Update and Read Values by Data Filter

Resolve a spreadsheet via a data filter, update matching ranges by filter, then read them back by filter.

ARAZZO

Pricing Plans

Rate Limits

Google Sheets Rate Limits

5 limits

RATE LIMITS

FinOps

Features

Spreadsheet Management

Create, read, update, and delete spreadsheets programmatically with full control over properties and metadata.

Cell Value Operations

Read and write individual cell values, ranges, and batch operations across multiple ranges.

Formatting

Apply rich formatting to cells including fonts, colors, borders, alignment, and number formats.

Sheet Management

Add, remove, copy, and configure individual sheets within a spreadsheet.

Developer Metadata

Attach custom metadata to spreadsheets, sheets, rows, and columns for application-specific data.

Data Validation

Set validation rules on cells to enforce data quality and consistency.

Conditional Formatting

Apply conditional formatting rules based on cell values and formulas.

Charts and Graphs

Create and manage embedded charts within spreadsheets.

Named Ranges

Define and manage named ranges for easier formula references.

Batch Operations

Execute multiple read and write operations in a single API call for efficiency.

Use Cases

Data Collection and Reporting

Collect data from various sources and generate automated reports in Google Sheets.

Database Backend

Use Google Sheets as a lightweight database for web applications and prototypes.

Workflow Automation

Automate data entry, processing, and distribution workflows using the API.

Data Integration

Synchronize data between Google Sheets and other business applications.

Dashboard Creation

Build interactive dashboards and visualizations from spreadsheet data.

Integrations

Google Workspace

Deep integration with Google Docs, Slides, Forms, and other Workspace applications.

Google Apps Script

Extend Sheets functionality with custom functions, menus, and automation scripts.

Google Cloud Platform

Connect to BigQuery, Cloud Functions, and other GCP services for advanced data processing.

Zapier

Connect Google Sheets to thousands of apps through Zapier automation workflows.

Slack

Send notifications and updates to Slack channels based on spreadsheet changes.

Semantic Vocabularies

Google Sheets Context

0 classes · 0 properties

JSON-LD

API Governance Rules

Google Sheets API Rules

7 rules · 7 errors

SPECTRAL

JSON Structure

Google Sheets Banded Range Structure

1 properties

JSON STRUCTURE

Google Sheets Banding Properties Structure

0 properties

JSON STRUCTURE

Google Sheets Basic Filter Structure

3 properties

JSON STRUCTURE

Google Sheets Boolean Condition Structure

2 properties

JSON STRUCTURE

Google Sheets Border Structure

2 properties

JSON STRUCTURE

Google Sheets Borders Structure

0 properties

JSON STRUCTURE

Google Sheets Cell Data Structure

4 properties

JSON STRUCTURE

Google Sheets Cell Format Structure

5 properties

JSON STRUCTURE

Google Sheets Clear Values Response Structure

2 properties

JSON STRUCTURE

Google Sheets Color Structure

4 properties

JSON STRUCTURE

Google Sheets Color Style Structure

1 properties

JSON STRUCTURE

Google Sheets Condition Value Structure

2 properties

JSON STRUCTURE

Google Sheets Data Execution Status Structure

4 properties

JSON STRUCTURE

Google Sheets Data Filter Structure

1 properties

JSON STRUCTURE

Google Sheets Data Source Column Structure

1 properties

JSON STRUCTURE

Google Sheets Data Source Formula Structure

1 properties

JSON STRUCTURE

Google Sheets Data Source Parameter Structure

2 properties

JSON STRUCTURE

Google Sheets Data Source Spec Structure

1 properties

JSON STRUCTURE

Google Sheets Data Source Structure

3 properties

JSON STRUCTURE

Google Sheets Data Source Table Structure

6 properties

JSON STRUCTURE

Google Sheets Data Validation Rule Structure

3 properties

JSON STRUCTURE

Google Sheets Developer Metadata Structure

4 properties

JSON STRUCTURE

Google Sheets Dimension Properties Structure

4 properties

JSON STRUCTURE

Google Sheets Dimension Range Structure

3 properties

JSON STRUCTURE

Google Sheets Dimension Structure

0 properties

JSON STRUCTURE

Google Sheets Embedded Chart Structure

2 properties

JSON STRUCTURE

Google Sheets Error Response Structure

1 properties

JSON STRUCTURE

Google Sheets Error Value Structure

2 properties

JSON STRUCTURE

Google Sheets Extended Value Structure

4 properties

JSON STRUCTURE

Google Sheets Filter Criteria Structure

1 properties

JSON STRUCTURE

Google Sheets Filter Spec Structure

1 properties

JSON STRUCTURE

Google Sheets Filter View Structure

6 properties

JSON STRUCTURE

Google Sheets Grid Coordinate Structure

3 properties

JSON STRUCTURE

Google Sheets Grid Data Structure

5 properties

JSON STRUCTURE

Google Sheets Grid Properties Structure

7 properties

JSON STRUCTURE

Google Sheets Grid Range Structure

5 properties

JSON STRUCTURE

Google Sheets Interpolation Point Structure

2 properties

JSON STRUCTURE

Google Sheets Link Structure

1 properties

JSON STRUCTURE

Google Sheets Named Range Structure

2 properties

JSON STRUCTURE

Google Sheets Number Format Structure

2 properties

JSON STRUCTURE

Google Sheets Padding Structure

4 properties

JSON STRUCTURE

Google Sheets Pivot Filter Criteria Structure

2 properties

JSON STRUCTURE

Google Sheets Pivot Filter Spec Structure

1 properties

JSON STRUCTURE

Google Sheets Pivot Group Limit Structure

2 properties

JSON STRUCTURE

Google Sheets Pivot Group Rule Structure

3 properties

JSON STRUCTURE

Google Sheets Pivot Group Structure

5 properties

JSON STRUCTURE

Google Sheets Pivot Table Structure

7 properties

JSON STRUCTURE

Google Sheets Pivot Value Structure

5 properties

JSON STRUCTURE

Google Sheets Protected Range Structure

7 properties

JSON STRUCTURE

Google Sheets Row Data Structure

1 properties

JSON STRUCTURE

Google Sheets Sheet Properties Structure

6 properties

JSON STRUCTURE

Google Sheets Sheet Structure

8 properties

JSON STRUCTURE

Google Sheets Slicer Structure

2 properties

JSON STRUCTURE

Google Sheets Sort Spec Structure

2 properties

JSON STRUCTURE

Google Sheets Spreadsheet Structure

7 properties

JSON STRUCTURE

Google Sheets Spreadsheet Theme Structure

2 properties

JSON STRUCTURE

Google Sheets Text Format Run Structure

1 properties

JSON STRUCTURE

Google Sheets Text Format Structure

6 properties

JSON STRUCTURE

Google Sheets Text Rotation Structure

2 properties

JSON STRUCTURE

Google Sheets Value Input Option Structure

0 properties

JSON STRUCTURE

Google Sheets Value Range Structure

2 properties

JSON STRUCTURE

Google Sheets Value Render Option Structure

0 properties

JSON STRUCTURE

Example Payloads

Google Sheets Border Example

2 fields

EXAMPLE

Google Sheets Color Example

4 fields

EXAMPLE

Google Sheets Link Example

1 fields

EXAMPLE

Google Sheets Sheet Example

8 fields

EXAMPLE

Google Sheets Slicer Example

2 fields

EXAMPLE

Resources

🔗
PostmanWorkspace
PostmanWorkspace
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🌐
Portal
Portal
🔗
Documentation
Documentation
📰
Blog
Blog
👥
GitHubOrganization
GitHubOrganization
💬
Support
Support
🟢
StatusPage
StatusPage
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
📝
Signup
Signup
🔗
Login
Login
👥
StackOverflow
StackOverflow
👥
YouTube
YouTube
🚀
GettingStarted
GettingStarted
🔑
Authentication
Authentication
📦
SDKs
SDKs
📄
ReleaseNotes
ReleaseNotes
💰
Pricing
Pricing
🔗
RateLimits
RateLimits
🔗
SpectralRules
SpectralRules

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Google Sheets API
  version: v4
request:
  auth:
    type: oauth2
    flow: authorization_code
    authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth
    accessTokenUrl: https://oauth2.googleapis.com/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Spreadsheets
    type: folder
  items:
  - info:
      name: Google Sheets Create a Spreadsheet
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets
      body:
        type: json
        data: '{}'
    docs: Creates a new spreadsheet, optionally with initial properties, sheets, and data.
  - info:
      name: Google Sheets Get a Spreadsheet
      type: http
    http:
      method: GET
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      - name: ranges
        value: ''
        type: query
        description: The ranges to retrieve from the spreadsheet.
      - name: includeGridData
        value: 'true'
        type: query
        description: True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
    docs: Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids
      is not returned. You can include grid data in one of two ways using the fields URL parameter or the includeGridData
      query parameter.
  - info:
      name: Google Sheets Batch Update a Spreadsheet
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId:batchUpdate
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      body:
        type: json
        data: '{}'
    docs: Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is
      not valid, the entire request will fail and nothing will be applied.
  - info:
      name: Google Sheets Get a Spreadsheet by Data Filter
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId:getByDataFilter
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      body:
        type: json
        data: '{}'
    docs: Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from getSpreadsheet
      in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter.
- info:
    name: Values
    type: folder
  items:
  - info:
      name: Google Sheets Get Values From a Range
      type: http
    http:
      method: GET
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/values/:range
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      - name: range
        value: ''
        type: path
        description: The A1 notation or R1C1 notation of the range to read or modify. For example, Sheet1!A1:D5 or Sheet1!R1C1:R5C4.
      - name: majorDimension
        value: example_value
        type: query
        description: The major dimension that results should use.
      - name: valueRenderOption
        value: example_value
        type: query
        description: How values should be represented in the output.
      - name: dateTimeRenderOption
        value: example_value
        type: query
        description: How dates, times, and durations should be represented in the output.
    docs: Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.
  - info:
      name: Google Sheets Update Values in a Range
      type: http
    http:
      method: PUT
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/values/:range
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      - name: range
        value: ''
        type: path
        description: The A1 notation or R1C1 notation of the range to read or modify. For example, Sheet1!A1:D5 or Sheet1!R1C1:R5C4.
      - name: valueInputOption
        value: example_value
        type: query
        description: How the input data should be interpreted.
      - name: includeValuesInResponse
        value: 'true'
        type: query
        description: Determines if the update response should include the values of the cells that were updated.
      - name: responseValueRenderOption
        value: example_value
        type: query
        description: Determines how values in the response should be rendered.
      - name: responseDateTimeRenderOption
        value: example_value
        type: query
        description: Determines how dates, times, and durations in the response should be rendered.
      body:
        type: json
        data: '{}'
    docs: Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.
  - info:
      name: Google Sheets Append Values to a Range
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/values/:range:append
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      - name: range
        value: ''
        type: path
        description: The A1 notation or R1C1 notation of the range to read or modify. For example, Sheet1!A1:D5 or Sheet1!R1C1:R5C4.
      - name: valueInputOption
        value: example_value
        type: query
        description: How the input data should be interpreted.
      - name: insertDataOption
        value: OVERWRITE
        type: query
        description: How the input data should be inserted.
      - name: includeValuesInResponse
        value: 'true'
        type: query
        description: Determines if the update response should include the values of the cells that were appended.
      - name: responseValueRenderOption
        value: example_value
        type: query
        description: Determines how values in the response should be rendered.
      - name: responseDateTimeRenderOption
        value: example_value
        type: query
        description: Determines how dates, times, and durations in the response should be rendered.
      body:
        type: json
        data: '{}'
    docs: Appends values to a spreadsheet. The input range is used to search for existing data and find a table within that
      range. Values will be appended to the next row of the table, starting with the first column of the table.
  - info:
      name: Google Sheets Clear Values From a Range
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/values/:range:clear
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      - name: range
        value: ''
        type: path
        description: The A1 notation or R1C1 notation of the range to read or modify. For example, Sheet1!A1:D5 or Sheet1!R1C1:R5C4.
      body:
        type: json
        data: '{}'
    docs: Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared;
      all other properties of the cell (such as formatting and data validation) are kept.
  - info:
      name: Google Sheets Get Values From Multiple Ranges
      type: http
    http:
      method: GET
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/values:batchGet
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      - name: ranges
        value: ''
        type: query
        description: The A1 notation or R1C1 notation of the range to retrieve values from.
      - name: majorDimension
        value: example_value
        type: query
        description: The major dimension that results should use.
      - name: valueRenderOption
        value: example_value
        type: query
        description: How values should be represented in the output.
      - name: dateTimeRenderOption
        value: example_value
        type: query
        description: How dates, times, and durations should be represented in the output.
    docs: Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more
      ranges.
  - info:
      name: Google Sheets Update Values in Multiple Ranges
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/values:batchUpdate
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      body:
        type: json
        data: '{}'
    docs: Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption,
      and one or more ValueRanges.
  - info:
      name: Google Sheets Clear Values From Multiple Ranges
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/values:batchClear
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      body:
        type: json
        data: '{}'
    docs: Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more
      ranges. Only values are cleared; all other properties of the cell are kept.
  - info:
      name: Google Sheets Get Values From Ranges Matching Data Filters
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/values:batchGetByDataFilter
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      body:
        type: json
        data: '{}'
    docs: Returns one or more ranges of values that match the specified data filters. The caller must specify the spreadsheet
      ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.
  - info:
      name: Google Sheets Update Values in Ranges Matching Data Filters
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/values:batchUpdateByDataFilter
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      body:
        type: json
        data: '{}'
    docs: Sets values in one or more ranges of a spreadsheet matching the specified data filters. The caller must specify
      the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.
  - info:
      name: Google Sheets Clear Values From Ranges Matching Data Filters
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/values:batchClearByDataFilter
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      body:
        type: json
        data: '{}'
    docs: Clears one or more ranges of values from a spreadsheet matching the specified data filters. The caller must specify
      the spreadsheet ID and one or more DataFilters.
- info:
    name: Sheets
    type: folder
  items:
  - info:
      name: Google Sheets Copy a Sheet to Another Spreadsheet
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/sheets/:sheetId:copyTo
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      - name: sheetId
        value: '500123'
        type: path
        description: The ID of the sheet to copy.
      body:
        type: json
        data: '{}'
    docs: Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.
- info:
    name: developerMetadata
    type: folder
  items:
  - info:
      name: Google Sheets Get Developer Metadata
      type: http
    http:
      method: GET
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/developerMetadata/:metadataId
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      - name: metadataId
        value: '500123'
        type: path
        description: The ID of the developer metadata to retrieve.
    docs: Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer
      metadata's unique metadataId.
  - info:
      name: Google Sheets Search Developer Metadata
      type: http
    http:
      method: POST
      url: https://sheets.googleapis.com/v4/spreadsheets/:spreadsheetId/developerMetadata:search
      params:
      - name: spreadsheetId
        value: ''
        type: path
        description: The ID of the spreadsheet to retrieve or modify.
      body:
        type: json
        data: '{}'
    docs: Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup
      object, this will return all DeveloperMetadata entries selected by it.
bundled: true