API Connector Documentation
Import CoachAccountable Data to Google Sheets
In this guide, we’ll walk through how to pull data from the CoachAccountable API directly into Google Sheets, using the API Connector add-on for Sheets.
Contents
- Before You Begin
- Part 1: Get CoachAccountable API Key
- Part 2: Pull CoachAccountable API Data into Sheets
- Part 3: More Example API Requests
- Part 4: API Documentation
Before You Begin
Click here to install the API Connector add-on from the Google Marketplace.
Part 1: Get Your CoachAccountable API Key
- Log in to CoachAccountable and click your profile icon > Settings > System > API Access from the right sidebar (or just navigate to https://www.coachaccountable.com/app/API directly).
- You should now see your API ID and private API key.
- Keep these handy as you'll need them shortly. Congrats! You're now ready to use the CoachAccountable API.
Part 2: Pull CoachAccountable API Data into Sheets
For this example, we'll get a list of clients. This API uses the same URL for all requests: https://www.coachaccountable.com/API/
. Different types of requests are defined in the request body using the a
parameter. Here's how to configure the request:
- Open up Google Sheets and click Extensions > API Connector > Open > Create request.
- In the request form enter the following:
- Application:
Custom
- Method:
POST
- Request URL:
https://www.coachaccountable.com/API/
- Request body:
{"APIID":"your_app_id", "APIKey":"your_api_key", "a":"Client.getAll"}
- Application:
- 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 your CouchAccountable client data populate your Google Sheet.
Part 3: More Example API Requests
You can view the full set of endpoints in the API documentation, but if you just want to get started, try out the following example request bodies. Just substitute in your own APIID
and APIKey
values.
- Add a new client
{"APIID":"your_api_id", "APIKey":"your_api_key", "a":"Client.add", "firstName":"Peter", "lastName":"Piper", "email":"[email protected]"}
- Get all actions for a client
{"APIID":"your_api_id", "APIKey":"your_api_key", "a":"Action.getAllProjects", "ClientID":"your_client_id"}
- Get all metrics for a client
{"APIID":"your_api_id", "APIKey":"your_api_key", "a":"Metric.getAll", "ClientID":"your_client_id"}
- Get invoice payments
{"APIID":"your_api_id", "APIKey":"your_api_key", "a":"Invoice.getPayments"}
Part 4: API Documentation
Official API documentation: https://www.coachaccountable.com/APIDocs#introduction