Shortcut Project Mgmt API Integration Tutorial for Beginners

How to connect the Shortcut API to Google Sheets

Shortcut, formerly Clubhouse, is a project management software. We can use the Shortcut API to import data from Shortcut into Google Sheets. In this tutorial, we’ll show you how to connect the Shortcut REST API to Google Sheets in 5 steps:

Install the Apipheny add-on
Obtain an API token
Choose an endpoint
Enter your API request into Apipheny
Run the API request

Step 1.) Install and open the Apipheny add-on for Google Sheets

Apipheny is an API connector for Google Sheets. You can use Apipheny to connect your Google Sheets to unlimited API data sources, make unlimited API requests, and more. There is a 30 day free trial included.

1.) Install Apipheny by opening the following link on desktop and then clicking the Install button in the Google Marketplace: https://apipheny.io/install

2.) After you’ve installed Apipheny, open a Google Sheet and then click on the Extensions dropdown in the menu at the top.

In the dropdown list you should see Apipheny. Click Apipheny then click Import API to open the Apipheny sidebar in your Google Sheet.

Tip: you can open a new Google Sheet by entering this URL in your browser: sheet.new

Step 2.) Obtain an API token

After logging into your Shortcut account, click the user icon from the bottom-left corner, then in the displayed menu click the Settings option:

Clubhouse account Dashboard — Account Dashboard

Click the API Tokens option from the menu on the left:

Clubhouse Settings section — Settings section

In the API Tokens section, type a name in the Token Name field, then click the Generate Token button:

Clubhouse API Tokens section — API Tokens section

Your token is now generated. Copy it to a safe location because you’ll need it in the next steps:

Clubhouse Generated Token — Generated Token

Step 3.) Choose an Endpoint

In this section, we’ll show you how to browse the Shortcut API documentation to find the API URL that retrieves the information you need from your account. If you already know your URL, or you want to use the same example URL as us, just skip to Step 4.

First, open the Shortcut API documentation page: https://shortcut.com/api/rest/v3

The menu on the left contains an Introduction section and a list of categories, each with its own endpoints.

For example, if we click the Entity-Templates category, a list with its endpoints will be displayed:

An example endpoint is List Entity Templates which lists all the entity templates for an organization:

https://api.app.shortcut.com/api/v3/entity-templates

The endpoint’s documentation contains a short description of its purpose, the HTTP method (eg. GET), its URI, an example request as a cURL command and its associated example response:

List Entity Templates endpoint documentation

All API calls for Shortcut should be made to the https://api.app.shortcut.com/api/v3/ base domain.

Step 4.) Enter your API request into Apipheny

Now go back to your Google Sheet and make sure that the Apipheny add-on is open on the Import tab. With the Import tab open, enter these details into the add-on:

Method: At the top of the Apipheny sidebar, select the HTTP method (GET or POST) required by your API endpoint. For this example, we are using the GET method.

API URL: In Step 3, we explained how you can find the Shortcut API endpoint that you need. Now copy and paste your complete API URL into the Apipheny add-on, where it says API URL Path, followed by any parameters required for your query (if applicable).

For this example, we are using the List Categories endpoint which returns a list of all categories and their attributes. This is what the whole URL looks like:

https://api.app.shortcut.com/api/v3/categories

Headers: In the Headers section of Apipheny, add two rows with the following key and value:

Header 1
Key:
Shortcut-Token
Value:
your_token

Header 2
Key:
Content-Type
Value:
application/json

your_ token value is the string you generated previously, in Step 2.

Clubhouse API request entered into Apipheny — API request entered into Apipheny

Step 5.) Run the API request

Finally, the last step is to click the Run button at the bottom of the Apipheny add-on and then wait for the API data to be imported into your Google Sheet. Here’s what our request looked like when completed:

Clubhouse data imported into Google Sheets — Shortcut data imported into Google Sheets

That’s it! You’ve successfully connected your Shortcut account to Google Sheets using the Shortcut API, Google Sheets API, and the Apipheny add-on.

After making a successful request to the Shortcut API, try querying a different API endpoint, or try using one of the more advanced features in the Apipheny add-on.