Search API Connector Documentation
Import Jira Data to Google Sheets
In this guide, we’ll walk through how to pull data from the Jira REST API directly into Google Sheets, using the API Connector add-on for Sheets.
There are 2 ways to connect to the Jira API:
- Preset “Connect” button (OAuth) premium
- Personal API token. Please check the appendix for detailed instructions to retrieve your token.
- Before You Begin
- Part 1: Connect to the JIRA API
- Part 2: Get Your Cloud ID
- Part 3: Pull JIRA API API Data into Sheets
- Part 4: More Example API URLs
- Part 5: Handle Pagination
- Part 6: API Documentation
- Appendix: Connect with an API Token
Before You Begin
Click here to install the API Connector add-on from the Google Marketplace.
Part 1: Connect to the Jira API
If you haven’t connected to the Jira API before, you’ll first need to initiate the connection.
- Open up Google Sheets and click Extensions > API Connector > Manage Connections.
- In the list of available connections, find Jira and click Connect.
- You will see a page asking you to approve the connection. Click Accept.
- You’ll then be returned to your Google Sheet, and can verify that your Jira connection is active in the Connections screen.
Part 2: Get Your Cloud ID
If you’re connecting via OAuth, you will need your cloud ID for all requests.
To get your cloud Id, run a request URL of
Part 3: Pull Jira API Data into Sheets
Now let’s get some data about your projects.
- The URL for projects is
- In API Connector’s Create screen, enter that URL, plugging in your cloud ID where it says your-cloudId:
- Choose “Jira” from the drop-down authentication menu. It should say “Connected.”
- Under Headers, enter Key = Content-type, Value = application/json.
- Create a new tab and click Set current to use that tab as your data destination.
- Name your request and click Run. A moment later you’ll see a list of your Jira projects in your Google Sheet:
Part 4: More Example API URLs
You can check the documentation for the full list of available API requests, but if you just want to jump in, you can play around with the URLs you enter in the API URL path field. Try the following (one at a time).
The URLs are a bit different depending on whether you’re connecting via OAuth or through an API token:
API Token URLs
Part 5: Handle Pagination
- By default Jira limits the number of results in a single response (usually to 50 records) as described here. To get more records, you would use the
- In API Connector you can run these paged requests separately, or loop through them automatically using pagination handling (paid feature). Jira provides the complete next page URL in a field called “nextPage”, so it would be entered like this:
- Pagination type: next page URL
- Next page path: nextPage
- Run until: choose when to stop fetching data
Part 6: API Documentation
Official API documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/
To view or remove the connection click here: https://id.atlassian.com/manage-profile/apps
Appendix: Connect with a Jira API Token
- While logged into your Jira account, navigate to https://id.atlassian.com/manage/api-tokens and click Create API token.
- A modal will appear, prompting you to give your token a name. You can name it anything. Click Create.
- You’ll now see a new modal containing your API token. Copy this to your clipboard as you’ll need it in a moment (and they won’t show it to you again).
- One more step: we need to encode this token to base 64 (aka Basic Authentication). You can do this by entering your your credentials in the format
your_email_address:your_tokeninto this form (i.e. your JIRA email address, then a colon, and then the API token you just got).
The encoding script runs in your browser, and none of your credentials are seen or stored by this site.
- Now, when you run your request, enter two sets of key-value pairs under Headers, like this:
Authorization: Basic your_encoded_token
- URLs are different depending on whether you connect via OAuth or an API token, so make sure to use the URL syntax shown in the list of API token URLs.