IN THIS SECTION


Overview

The Joiin API is a RESTful API which you can use to programatically query data from Joiin using tools such as PowerBI or Zapier or with your own handwritten code.



Getting Started

To get started with the API you need to set up an API key, to do this, log into the Joiin app and go to the Account menu at the top right and select API Access.


If you haven't already, click on the Generate API Key button and an API key will be generated. Wait a short time for the key to be generated and validated then you can copy the key into your clipboard by clicking on the Copy button - and from there use it wherever you are connecting the the API or in Zapier.


If you have already generated a key you can come back and copy it again any time.


You can regenerate key any time if needed.



Documentation


API reference documentation can be found here.


Zapier

If your integration platform of choice is Zapier then you can use the Joiin Zapier app. This is a purpose built app which is available within the Zapier app library and provides a quick and easy way to connect Joiin to 8000+ other apps.


Getting Started

To get started just head over to the Joiin Zapier app page, or just log into your Zapier account and start creating a Zap with the JoiinApp.


Creating a Zap

To create a Zap using Joiin follow these simple steps.


  • Log into Zapier 
  • Click on the + Create button and select New Zap
  • Click on the first Trigger event and search for the Joiin app



  • Select the Joiin app
  • In the Setup select the Trigger event: Custom Report or Trial Balance (see below for more information on this)
  • In the Account, if you haven't already connected, click on Sign In



  • Enter the API Key from Joiin (as described above) and click Yes.
  • The account will be connected.


From there you can proceed to configure the rest of your trigger and any downstream events. See these two articles for a more in-depth step-by-step guide to set up your Zap.

 How to create a Zap to put Joiin Custom Report data into Google Sheets (using Google Drive App)


How to create a Zap to put Joiin Trial Balance data into Google Sheets (using Zapier Code and Google Sheets App)


An alternative to using the Joiin Zapier app is to use Zapier Webhooks to connect directly to the Joiin REST API.



Limits


API Throttle Limits

API calls are subject to throttle limits as follows.


  • Max 25000 requests per month
  • Max 200 concurrent requests
  • Max 100 requests per second


These limits are per API key. If you find you have hit a limit, you can re-generate a key so you can amend your code to reduce the number of calls. If you feel you have a valid reason to increase these limits please contact us at support@joiin.co.



Available reports

  • Trial Balance
  • Profit and Loss
  • Balance Sheet
  • Cashflow
  • Custom Reports (reports with your own layout)




Zapier Polling Limits


Zapier polling triggers perform checks at intervals ranging from every 1 to 15 minutes, depending on your Zapier subscription plan. For instance, on the Free and Starter plans, polling occurs every 15 minutes, while higher-tier plans offer more frequent polling intervals.


If you are hitting Joiin throttle limits you can change the frequency of triggers or set up scheduled triggers - see this Zapier article for more information.


Examples


An example of connecting Google Sheets to Joiin using Zapier can be found here.


Examples using Javascript and Python can be found on GitHub here.