Google Sheets API (all endpoints)
Reads and writes Google Sheets.
Productivity & workspace#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Reads and writes Google Sheets.
Endpoints 17
spreadsheets
- POSTApplies one or more updates to the spreadsheet
/v4/spreadsheets/:spreadsheetId:batchUpdateApplies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail… - POSTCreates a spreadsheet, returning the newly created spreadsheet.
/v4/spreadsheetsCreates a spreadsheet, returning the newly created spreadsheet. - GETReturns the spreadsheet at the given ID
/v4/spreadsheets/:spreadsheetId?commentsViewMode=COMMENTS_VIEW_MODE_UNSPECIFIED&excludeTablesInBandedRanges=true&includeGridData=true&ranges=stringReturns 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… - POSTReturns the spreadsheet at the given ID
/v4/spreadsheets/:spreadsheetId:getByDataFilterReturns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see Read, write, and search metadata. This method…
spreadsheets.developerMetadata
- GETReturns the developer metadata with the specified ID
/v4/spreadsheets/:spreadsheetId/developerMetadata/:metadataIdReturns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. For more… - POSTReturns all developer metadata matching the specified DataFilter
/v4/spreadsheets/:spreadsheetId/developerMetadata:searchReturns all developer metadata matching the specified DataFilter. For more information, see Read, write, and search metadata. If the provided DataFilter…
spreadsheets.sheets
- POSTCopies a single sheet from a spreadsheet to another spreadsheet
/v4/spreadsheets/:spreadsheetId/sheets/:sheetId:copyToCopies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.
spreadsheets.values
- POSTAppends values to a spreadsheet
/v4/spreadsheets/:spreadsheetId/values/:range:append?includeValuesInResponse=true&insertDataOption=OVERWRITE&responseDateTimeRenderOption=SERIAL_NUMBER&responseValueRenderOption=FORMATTED_VALUE&valueInputOption=INPUT_VALUE_OPTION_UNSPECIFIEDAppends 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… - POSTClears one or more ranges of values from a spreadsheet
/v4/spreadsheets/:spreadsheetId/values:batchClearClears 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… - POSTClears one or more ranges of values from a spreadsheet
/v4/spreadsheets/:spreadsheetId/values:batchClearByDataFilterClears one or more ranges of values from a spreadsheet. For more information, see Read, write, and search metadata. The caller must specify the spreadsheet ID… - GETReturns one or more ranges of values from a spreadsheet
/v4/spreadsheets/:spreadsheetId/values:batchGet?dateTimeRenderOption=SERIAL_NUMBER&majorDimension=DIMENSION_UNSPECIFIED&ranges=string&valueRenderOption=FORMATTED_VALUEReturns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. - POSTReturns one or more ranges of values that match the specified data filters
/v4/spreadsheets/:spreadsheetId/values:batchGetByDataFilterReturns one or more ranges of values that match the specified data filters. For more information, see Read, write, and search metadata. The caller must… - POSTSets values in one or more ranges of a spreadsheet
/v4/spreadsheets/:spreadsheetId/values:batchUpdateSets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges. - POSTSets values in one or more ranges of a spreadsheet
/v4/spreadsheets/:spreadsheetId/values:batchUpdateByDataFilterSets values in one or more ranges of a spreadsheet. For more information, see Read, write, and search metadata. The caller must specify the spreadsheet ID, a… - POSTClears values from a spreadsheet
/v4/spreadsheets/:spreadsheetId/values/:range:clearClears 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… - GETReturns a range of values from a spreadsheet
/v4/spreadsheets/:spreadsheetId/values/:range?dateTimeRenderOption=SERIAL_NUMBER&majorDimension=DIMENSION_UNSPECIFIED&valueRenderOption=FORMATTED_VALUEReturns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. - PUTSets values in a range of a spreadsheet
/v4/spreadsheets/:spreadsheetId/values/:range?includeValuesInResponse=true&responseDateTimeRenderOption=SERIAL_NUMBER&responseValueRenderOption=FORMATTED_VALUE&valueInputOption=INPUT_VALUE_OPTION_UNSPECIFIEDSets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.
API details
- Base URL
https://sheets.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 5 scopes
An API key in the key query parameter - Operations
- 17 operations on 16 pathsPOST 12GET 4PUT 1
- Main resources
- spreadsheets.values 10spreadsheets 4spreadsheets.developerMetadata 2spreadsheets.sheets 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v4 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Google Sheets API (all endpoints) in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Google Sheets API (all endpoints) collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 5 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Applies one or more updates to the spreadsheet” (POST /v4/spreadsheets/:spreadsheetId:batchUpdate), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Google Sheets API (all endpoints)?
Reads and writes Google Sheets. It is listed under Productivity & workspace and has 17 endpoints.
Who publishes the Google Sheets API (all endpoints)?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Google Sheets API (all endpoints)?
Requests go to https://sheets.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Google Sheets API (all endpoints)?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 5 scopes; an API key in the key query parameter.
How many endpoints does the Google Sheets API (all endpoints) have?
17 operations on 16 paths (12 POST, 4 GET, 1 PUT). The largest groups are spreadsheets.values, spreadsheets, spreadsheets.developerMetadata, spreadsheets.sheets.
Is forking the Google Sheets API (all endpoints) free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.