An API key is a secure token that gives an external platform or tool permission to connect directly to your Ivorey
account. Once connected, that tool can send or retrieve data, like reading your contacts, creating opportunities, or sending messages, without you having to do it manually.
You would need an API key if you want to connect a tool or platform that isn't available as a built-in integration inside Ivorey, and that external tool/platform supports a direct API connection. Some examples:
A developer is building a custom tool or automation for your business
You are using a platform that connects to external tools via API (e.g. a specialised scheduling tool, external landing pages, dedicated financial accounting software)
You are using a service that asks for an API key or access token during its setup process
This guide is perfect if you want to:
Generate an API key (Private Integration token) for your Ivorey account
Connect an external platform or tool, and control what it’s allowed to access
account (e.g. contacts, payments, etc.). You will select these permissions when creating your Private Integration. With an External Platform via APIIn Ivorey, API keys are generated through Private Integrations, which are actually more powerful and more secure than traditional API keys, because you can control exactly what the connected tool is allowed to access - rather than giving it unrestricted access to your entire account.
You can create as many Private Integrations as you need - we recommend one per external tool so you can manage and revoke access individually.
From the main Ivorey menu, go to Settings > Private Integrations > and click the [Create New Integration] button
Give your integration a clear Name, that describes what it connects to so you can identify it easily later (e.g. Tool Name Integration) > give it a Description (optional) > and click the [Next] button
On the Scopes page, select the areas of your account that the external tool will need access to, from the drop-down:
Check the boxes to select the View or Edit option for each relevant area > or select both (scope options include: Contacts, Calendars, Conversations, Opportunities, Forms, Payments, and more)
Note: Only select what the tool actually needs (e.g. if it only needs to read and update contacts in Ivorey, select only the View and Edit options for Contacts, and leave the rest unchecked). You can update these permissions later without needing to generate a new token.
Click the [Create] button
Your Private Integration Token (your API key) will now be displayed > click the [⧉] copy icon to copy the key > paste and store it somewhere secure, to be used in the upcoming steps
Note: For security purposes, the full token is only shown once at the time of creation. If you lose it, you will need to rotate it to generate a new one. The token should be treated like an important password - never share it publicly or store it in unsecured documents.
Most external platforms that connect via API will also ask for your Location ID - this tells the tool which specific Ivorey account it is connecting to.
From the main Ivorey menu, go to Settings > Business
In the General Information area, on the left, you will find your Location ID > click the [⧉] copy icon to copy the ID
Save this alongside your token, to use in the next step
Now you can log into your account for the external platform or tool, and input your Private Integration Token and Location ID to connect the two.
Every platform handles this slightly differently, but you are generally looking for a settings area called something like API, Integrations, Developer Settings, or Connected Apps. Within that area, look for fields labelled:
API Key, Token, Access Token, or Authorization - this is where your Private Integration Token should be pasted in
Location ID, Account ID, or Workspace ID - this is where your Ivorey Location ID should be pasted in
If you are unsure where to find these fields in the specific platform, search for their help documentation for "API connection" or "custom integration", or reach out to their support directly.
, but we can’t provide setup support for third-party platforms. For help with a specific tool's API setup, refer to that platform's documentation or reach out to their support.Once a Private Integration has been created, you can manage, update or delete it at any time from your Settings. You can also rotate your integration, to generate a fresh token with the same scopes, which can then be updated on the external platform to maintain the connection.
From the main Ivorey menu, go to Settings > Private Integrations > and click on any of your private integrations
Rotate it, if needed:
Rotate and expire this token later - issues a new token and gives the old one a 7-day grace period before it expires. Use this when a developer or connected tool needs time to update their end
Rotate and expire this token now - immediately invalidates the old token and issues a new one. Use this if your token has been compromised or shared accidentally
Note: If you rotate or delete an integration, the connected tool will lose access immediately and will need to be updated with the new token before it can reconnect.
In the top right corner, click the [⋮] three dots to:
Edit - update the name, description or adjust the scope permissions at any time, without needing to generate a new token
Note: If the scopes are updated, the connected tool's access will update immediately.
Delete - permanently remove the integration and revoke access for the connected tool immediately
There is no limit to the number of Private Integrations you can set up inside Ivorey. We recommend creating one per external tool or use case so that you can manage and revoke access individually, without affecting other connections.
Think of scopes as giving a key that only opens specific doors. A tool that only needs contact data doesn't need access to your payments or calendar, and limiting access keeps your account more secure.
Hit the support chat widget inside Ivorey - we can:
Walk you through any of the steps
Troubleshoot anything that’s not working
We’re here and ready to help via the chat widget in the bottom right of your Ivorey account. Or if you are looking for done-for-you support, you can browse our current services here 
