API Keys

API keys let your Spreadsheet.com account exchange information with third-party data sources and applications.

Spreadsheet.com allows you to generate API keys for two different use cases: connecting with the REST API, and connecting with Zapier. API keys let your Spreadsheet.com account exchange information with third-party data sources and applications.

Accessing Your API Keys

API keys can be accessed from the Personal settings dialog. Click on your profile picture in the top right corner of the screen to open the Personal settings dialog and then select API keys from the top menu bar.

Access-personal-settings.png

Here, you can view your existing API keys and generate new ones.

Generating New API Keys

To create a new API key, click the blue Generate API key button in the top right corner of the dialog.

Personal-settings-dialog.png

From the Generate API key dialog, you can give your new key a name as well as configure its settings.

API-key-types.png

Usage

API keys can be generated for two different use cases: connecting with the REST API, and connecting with Zapier. REST API keys can be used to connect with workbooks that are accessible to you, and Zapier keys can be used to connect with workbooks that you own.

Type

Spreadsheet.com API keys can be configured as Read & Write,  or Read Only, or Write Only.

API-key-select-type.png

If your API key is set to Read Only, services accessing your workbooks with the API key will be able to read data but will not be able to change or add data.

If your API key is set to Write Only, services accessing your workbooks with the API key will be able to change or add data, but will not be able to read existing data.

If your API key is set to Read & Write, services accessing your workbooks with the API key will be able to read and make changes to your workbooks.

Scope

For the REST API, Spreadsheet.com API keys can be used to connect with all of the workbooks for which you have access or can be restricted to a specific workbook for which you have access.

For Zapier, Spreadsheet.com API keys can be used to connect with all of the workbooks in which you are an Owner or can be restricted to a specific workbook that you own. Select one of the two options under the Entity header..

Once an API key is generated, you cannot change its settings. If you need to make changes, you will need to delete the existing API key and create a new one.

Once you configure your API key settings, click the Generate & View button in the bottom right corner of the dialog. A new dialog will appear with your API key. Click the Copy key button and then Done.

Once you close this dialog, you cannot view your API key again. Make sure you copy and save your key somewhere before closing the dialog.

Deleting Your API Keys

To delete an existing API key, click the three dot button on the right side of the API key and select “Delete API key” from the dropdown.

If you delete an API key, any service using that key to connect to Spreadsheet.com will no longer function. Proceed with caution, as deleting an API key cannot be undone.