API Key

Search

  1. Follow Up Boss - Help Center
  2. Integrations
  3. Other

Becca
  • Updated

Generate API keys within your FUB account to integrate with other systems. By default, anyone can create an API key. Accounts with the API Key Restriction Power-Up can turn off the ability to create new keys.

⚠️ API Keys give access to all information in your FUB account. Keep API keys confidential. 

 

Creating an API Key

1. Go to Admin > API

2. Click Create API Key mceclip0.png

3. Add the Name of the Integration 

4. Copy the API Key and directly Paste to the other system

5. Select Done

 

FAQs

How can I see a list of my account's API keys? 

You can see a list of all your API keys on the Admin > API screen, only the last 4 digits of the key are displayed for security.

mceclip3.png

You cannot see or copy a full API Key from this screen. If you need to copy your API Key (e.g. to connect a new integration), create a new API key by clicking Create API Key button above.

To make it easier to keep track of your API Keys, we show when each key was created and the last time it was used in the Created and Last Used columns in the table. If you hover your mouse over the Last Used time, it will show which integration(s) used that key and the last time it was used by each integration.

mceclip4.png

What does the "default" API key mean?
If you signed up for Follow Up Boss on or before July 30, 2021, you may see an API Key named "Default" in the list of API Keys.

mceclip10.png

You may wonder what this Key is used for since you didn't explicitly create it. This is your existing API Key that was automatically created for you when you signed up on or before July 30, 2021. We kept it so that integrations you may have connected using this key keep working and there is no service disruption.

If the Last Used column says Never and you're certain that no integrations should be using this key, you can delete it (see "Delete API key" section below). Please note, that you'll be logged out from mobile apps when you delete the Default API Key (this won't happen for normal API keys you create going forward). As with any other API Key, any integrations using it will stop working and you'll need to create a new key and update the integrations with that new key.

How do I rename an API key?
You can rename an API key to correct a typo or make it easier to understand what that key is for. Click on the edit icon and edit the name of the key.

mceclip5.png

mceclip6.pngT

How do I delete an API key?
If you stop using an integration, it's a good idea to delete the API Key that the integration was connected with. This will help secure your Follow Up Boss account by making sure only the integrations that you currently use have access to your Follow Up Boss account.

Click on the delete icon, double-check it's the right API key you want to delete, and confirm.

mceclip7.png

mceclip8.png

Integrations using that API key will lose access to your Follow Up Boss account and stop working immediately. If you made a mistake or changed your mind, create a new API Key and update the integrations with the new API Key.

Where can I view Follow Up Boss' API Documentation? 
If you're a software developer looking for API documentation, check our API docs.

Related articles