Search API Connector Documentation
Import Zendesk Data to Google Sheets
In this guide, we’ll walk through how to pull data from the Zendesk API directly into Google Sheets, using the API Connector add-on.
We’ll first get an API key from Zendesk, and then set up a request to pull in user data to your spreadsheet.
- Before You Begin
- Part 1: Get your Zendesk API Key
- Part 2: Create your API Request URL
- Part 3: Pull Zendesk API Data into Sheets
- Part 4: More Example API URLs
- Part 5: Handle Pagination
- Part 6: API Documentation
Before You Begin
Click here to install the API Connector add-on from the Google Marketplace.
Part 1: Get Your Zendesk API Key
- While logged into your Zendesk account, click Channels > API from the main dashboard.
- Tick the checkbox to agree to the terms of service, and click Get Started.
- Enable the setting for Token Access, and then click the plus (+) sign to add a new token.
- You will now see a token. Copy this and keep it secure as it won’t be displayed again.
- One last step: Because the Zendesk API requires Basic Authentication, we need to encode our authentication info to base 64. You can do this by entering your your credentials in the format
your_email_address/token:your_api_tokeninto this form, e.g.
[email protected]/token:6wiIBWbGkBMo1mRDMuVwkw1EPsNkeUj95PIz2akv. Your encoded credentials will appear underneath.
The encoding script runs in your browser, and none of your credentials are seen or stored by this site.
Part 2: Create Your Zendesk API Request URL
We’ll first get a list of users.
- API root: https://YOUR_DOMAIN.zendesk.com/api/v2/
Putting it together, we get the full API Request URL:
Just substitute in your own subdomain.
Part 3: Pull Zendesk API Data into Sheets
Now let’s enter that URL into API Connector.
- Open up Google Sheets and click Extensions > API Connector > Open.
- In the Create screen, enter the Request URL we just created
- We don’t need any OAuth for this request, so just leave that set to None.
- Under Headers, enter Authorization as your Key, and Basic YOUR_BASE64_ENCODED_STRING as the value:
Authorization Basic YOUR_BASE64_ENCODED_STRING
Replace YOUR_BASE64_ENCODED_STRING with the base64-encoded string you created in part 1, step 5.
- 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 users 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):
Part 5: Handle Pagination
Note that Zendesk limits the number of records returned in each request. By default, only 100 records will be returned unless you use the ‘page’ parameter as described in their documentation.
With API Connector, you can either set these up as separate requests or loop through their “next_page” links automatically with pagination handling (paid feature), like this:
next page URL
- Next page path:
- Run until: choose when to stop fetching data
Part 6: API Documentation
Official API documentation: https://developer.zendesk.com/rest_api/docs/support/introduction