We use cookies to provide and improve our services, website, and customer support.
For more information on how we use cookies, please check out our Cookie Policy.

Decline Cookies
Accept Cookies
Manage Cookies

Integrations and Add-ons

Connect and automate your business with other tools and features.

Generating API Keys

Sam Written by Sam
... on a stunning September day.

📖 In This Article

What is an API Key?
Generating an API Key
Disabling an API Key
Keeping your API Keys safe

What is an API Key?

An API Key is a unique code which allows different apps to talk to one another. Providing an API Key to another app allows them account access.

It is very important to protect API Keys, as they allow account access – just like a password. Be sure to always keep them safe and secure.

Generating an API Key

  1. Go to Setup > Connections API Keys.
  2. Click Generate API Key.
  3. Select the appropriate Locations that this API Key will have access to.
  4. Toggle the Status switch to enable the API Key.
  5. Enter a descriptive Note about what app or service is using this key.
  6. Click on the Save Changes button.
  7. Copy and paste the API Key into the appropriate field on the connecting app.

Disabling an API Key

If there is concern that an API Key has been compromised, or a particular API Key is no longer in use, we recommend disabling the API key by following the steps below.

  1. Go to Setup > Connections API Keys.
  2. Toggle the Status switch for the appropriate API Key to Key Disabled.
  3. Click on the Save Changes button.

Keeping your API Keys safe

Please make sure to:

  • Protect your API Keys like they are your account password.
  • Use a different API Key for each app or integration.
  • Only allow necessary Users access to the API Keys page.
  • Disable an API Key as soon as it is no longer being used.
Help Centre

How can we help?