Skip to main content

How to get a Cliniko API key

This information is based on the official instructions from nookalCliniko. If these instructions are out of date, please refer to the official instructions. 

API keys are very powerful, they can potentially enable full access to all of your business information. Please make sure you reviewed the API key safety tips to ensure you aren't putting your business at risk.

Nookal-Cliniko-specific Notes

  1. You(optional) can'tThe generateCliniko aAPI key fordoesn't "allinform locations",us youof mustyour justcliniko tickURL each(EG: location.bobs-burgers.au1.cliniko.com)
    We Thisdon't meansrequire thatthis information, but if you addprovide ait newwhile locationsetting up your Cliniko connection then The BOS can provide  ‘external links’ back to Nookalcliniko when you willare needlooking toat findpatients, theinvoices existing API key in nookal settings and edit it to include the new location.etc. 

Generating a NookalCliniko API Key

  1. GoClick toon SetupMy Info >under Connectionsyour >name
  2. Click API Keys. -> Manage API Keys
  3. Click GenerateAdd API Key. 
  4. Select the appropriate Locations that thisCopy API Key willas haveyou accesswon’t to.
  5. be
  6. Toggle the Status switchable to enablesee theit APIagain Key.
  7. Enter a descriptive Note about what app or service is using this key such as 'The BOS'.
  8. Click on the Save Changes button.
  9. Copy and paste the API Key into the appropriate field on the connecting app.

Removing a NookalCliniko API Key

  1. GoClick toon My Info under your name
  2. Click SetupAPI Keys -> Connections > Manage API Keys.
  3. Toggle theClick StatusArchive! switch forbeside the appropriate API Key to Key Disabled.
  4. Click on the Save Changes button.key