How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Google Sheets Spreadsheets API

Operations on spreadsheet resources

Google Sheets Spreadsheets API is one of 5 APIs that Google Sheets publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Spreadsheets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, an API reference, a changelog, and 1 JSON Schema.

This API exposes 4 operations across 4 paths, and defines 71 schemas. It is described by OpenAPI 3.2.0, at version v4.

Requests are made against a single base URL, https://sheets.googleapis.com/v4.

4 operations 4 paths 71 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v4
Base URL
https://sheets.googleapis.com/v4
Authentication
OAuth 2.0, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Google Sheets Spreadsheets API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 5 scopes. An API key is passed in the query as key (apiKey). By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 authentication for accessing user spreadsheets.
  • apiKey — API key for accessing public spreadsheets without user authentication.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Spreadsheets 4

Operations on spreadsheet resources

POST
/spreadsheets
Google Sheets Create a Spreadsheet
createSpreadsheet body → 200401403429
GET
/spreadsheets/{spreadsheetId}
Google Sheets Get a Spreadsheet
getSpreadsheet 3 params → 200401403404429
POST
/spreadsheets/{spreadsheetId}:batchUpdate
Google Sheets Batch Update a Spreadsheet
batchUpdateSpreadsheet 1 param body → 200401403404429
POST
/spreadsheets/{spreadsheetId}:getByDataFilter
Google Sheets Get a Spreadsheet by Data Filter
getSpreadsheetByDataFilter 1 param body → 200401403404429

Schemas 71

The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are CellFormat (12 properties), CellData (12 properties), Sheet (10 properties), SheetProperties (10 properties). Each schema is shown below with its type and property counts.

Color
object
Represents a color in the RGBA color space. Values are in the range [0, 1].
4 properties
FilterCriteria
object
Criteria for showing/hiding rows in a filter or filter view.
6 properties
ErrorValue
object
An error in a cell.
2 properties
PivotGroupSortValueBucket
object
Information about which values in a pivot group should be used for sorting.
2 properties
Link
object
An external or local reference.
1 property
TextRotation
object
The rotation applied to text in a cell.
2 properties
TextFormatRun
object
A run of a text format.
2 properties
BigQueryDataSourceSpec
object
The specification of a BigQuery data source that is connected to a sheet.
3 properties
Borders
object
The borders of the cell.
4 properties
DataValidationRule
object
A data validation rule.
4 properties
CellData
object
Data about a specific cell.
12 properties
Dimension
string
Indicates which dimension an operation should apply to.
DataSourceRefreshSchedule
object
Schedule for refreshing a data source.
6 properties
PivotTable
object
A pivot table.
9 properties
FilterSpec
object
The filter criteria associated with a specific column.
3 properties
DeveloperMetadataLookup
object
Selects DeveloperMetadata that matches all of the specified fields.
7 properties
DataSourceFormula
object
A data source formula.
2 properties
SortSpec
object
A sort order associated with a specific column or row.
7 properties
EmbeddedChart
object
A chart embedded in a sheet.
3 properties
TextFormat
object
The format of a run of text in a cell.
9 properties
Padding
object
The amount of padding around the cell, in pixels.
4 properties
SpreadsheetProperties
object
Properties of a spreadsheet.
8 properties
PivotValue
object
The definition of how a value in a pivot table should be calculated.
6 properties
BasicFilter
object
The default filter associated with a sheet.
4 properties
DataSourceSpec
object
This specifies the details of the data source.
2 properties
ConditionalFormatRule
object
A rule describing a conditional format.
3 properties
BooleanCondition
object
A condition that can evaluate to true or false.
2 properties
DataSourceColumnReference
object
An unique identifier that references a data source column.
1 property
DeveloperMetadataLocation
object
A location where metadata may be associated in a spreadsheet.
4 properties
BandedRange
object
A banded (alternating colors) range in a sheet.
4 properties
DimensionRange
object
A range along a single dimension on a sheet.
4 properties
PivotFilterSpec
object
The pivot table filter criteria associated with a specific source column offset.
3 properties
PivotGroup
object
A single grouping (either row or column) in a pivot table.
9 properties
SheetProperties
object
Properties of a sheet.
10 properties
GridProperties
object
Properties of a grid.
7 properties
NamedRange
object
A named range.
3 properties
ConditionValue
object
The value of the condition.
2 properties
IterativeCalculationSettings
object
Settings to control how circular dependencies are resolved with iterative calculation.
2 properties
PivotGroupLimit
object
The count limit on rows or columns in the pivot group.
2 properties
DataExecutionStatus
object
The data execution status.
4 properties
DataSourceColumn
object
A column in a data source.
2 properties
FilterView
object
A filter view.
7 properties
GridCoordinate
object
A coordinate in a sheet.
3 properties
BatchUpdateSpreadsheetResponse
object
The reply for batch updating a spreadsheet.
3 properties
DimensionProperties
object
Properties about a dimension.
5 properties
SpreadsheetTheme
object
Represents spreadsheet theme.
2 properties
InterpolationPoint
object
A single interpolation point on a gradient conditional format.
4 properties
ColorStyle
object
A color value.
2 properties
DataSourceParameter
object
A parameter in a data source's query.
3 properties
ProtectedRange
object
A protected range.
8 properties
GridRange
object
A range on a sheet. All indexes are zero-based.
5 properties
RowData
object
Data about each cell in a row.
1 property
DataSourceTable
object
A data source table, which allows the user to import a static table of data from the DataSource into Sheets.
7 properties
DataFilter
object
Filter that describes what data should be selected or returned from a request.
3 properties
Slicer
object
A slicer in a sheet.
3 properties
PivotGroupRule
object
An optional setting on a PivotGroup that defines buckets for the values in the source data column.
3 properties
ExtendedValue
object
The kinds of value that a cell in a spreadsheet can have.
5 properties
BandingProperties
object
Properties referring a single dimension (either row or column).
8 properties
PivotFilterCriteria
object
Criteria for showing/hiding rows in a pivot table.
3 properties
Border
object
A border along a cell.
4 properties
DataSourceSheetProperties
object
Additional properties of a DATASOURCE sheet.
3 properties
BatchUpdateSpreadsheetRequest
object
The request for updating any aspect of a spreadsheet.
4 properties
NumberFormat
object
The number format of a cell.
2 properties
ErrorResponse
object
An error response from the API.
1 property
DeveloperMetadata
object
Developer metadata associated with a location or object in a spreadsheet.
5 properties
CellFormat
object
The format of a cell.
12 properties
Sheet
object
A sheet in a spreadsheet.
10 properties
DataSource
object
Information about an external data source in the spreadsheet.
4 properties
GridData
object
Data in the grid, as well as metadata about the dimensions.
5 properties
Spreadsheet
object
A Google Sheets spreadsheet resource.
8 properties
EmbeddedObjectPosition
object
The position of an embedded object such as a chart.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

google-sheets-spreadsheets-api-openapi.yml Raw ↑

Other APIs Google Sheets publishes across the network.

Google Apps Script Spreadsheet Service
Google Sheets developerMetadata API
Google Sheets Sheets API
Google Sheets Values API
Where this information came from

This is an independent, third-party profile of Google Sheets Spreadsheets API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.