How to Create an API Key in AccuLynx

An API key is just a password-like code that lets two pieces of software talk to each other and share data automatically. If you use AccuLynx as your CRM (short for customer relationship management, the software that stores your leads and jobs) and you want it to connect to another tool, like a lead source, a phone system, or Zapier, that other tool will usually ask you for an AccuLynx API key first. This guide walks through what you need before you start, the exact steps to generate the key, and how to keep it safe once you have it.

1. What You Need Before You Start

Before you can generate a key, two things have to be true about your AccuLynx account.

• AppConnections must be turned on. API keys live inside a paid add-on called AppConnections. If you have never set up an integration before, you may need to enable it first. Go to the Market inside AccuLynx, find AppConnections under Add-Ons, and click "Enable." If you are not sure whether your account already has it, check with your AccuLynx administrator before you spend time hunting for a setting that is not turned on yet.
• You need administrator access. Only a Location or Company Administrator in AccuLynx can view Account Settings and create API keys. If you do not have admin permissions, you will not be able to see the API Keys page at all. In that case, ask your AccuLynx administrator to either create the key for you or grant you access.

Good to know: if your company has more than one AccuLynx location, each location needs its own API key. A key created for one location will not work for another, so make sure you are logged into the correct office before you generate one.

2. How to Create an API Key in AccuLynx

Once AppConnections is enabled and you are logged in as an administrator, generating a key only takes a few minutes.

Step 1: Open Account Settings

Log into AccuLynx and make sure you are in the correct office if your company has multiple locations. Click your name in the upper right corner, then choose "Account Settings" from the dropdown menu.

Step 2: Find the API Keys Page

In the menu on the left side of Account Settings, look for "Add-On Features and Integrations." Click it to open the submenu, then select "API Keys." Depending on your account, you may see this labeled as "View API Keys in AppConnections," which takes you to the same place.

Step 3: Start a New Key

On the API Keys page, click "Create Key" or "New" to open the form for a new key. If you land on a "Manage Connection" page first, look for a "New" button in the bottom right corner.

Step 4: Name the Key and Choose a Lead Source

Give the key a clear name so you know what it is for later, such as the name of the tool you are connecting it to. Some integrations require exact spelling and capitalization for the name, so if the tool you are connecting gave you specific instructions, follow them exactly. You will also be asked to pick a lead source, which is the bucket new leads from this integration will be filed under in AccuLynx. Many contractors create a new lead source that matches the tool's name, so it is easy to tell later which leads came from which integration.

Step 5: Create and Copy the Key

Once the form is filled out, click "Create Key." Your new key will now show up in the list along with any other keys you have already created. Click the "Copy Key" button next to it to copy the key to your clipboard, then paste it into whatever tool or integration is asking for it.

Heads up: AccuLynx will only show you the full key once, right after you create it. If you lose it, you generally cannot retrieve the same key again. You will need to create a new one and update it in the connected tool.

3. Keeping Your API Key Safe

Your API key can be used by anyone who has it to view or change your company's AccuLynx data, so treat it the same way you would treat a password.

• Do not share it over email or text where it could be forwarded around. Paste it directly into the tool that is asking for it.
• Give each integration its own key rather than reusing the same one everywhere. That way, if one connection ever needs to be shut off, you can deactivate just that key without breaking everything else.
• Check the list of keys every so often and remove any that belong to tools you no longer use.

If you are connecting AccuLynx to your phone system or lead sources, this is also a good moment to think about which tools actually need that access. Alivo, for example, connects to 600 or more CRMs, lead sources, and scheduling tools, AccuLynx included, so calls, texts, and bookings sync automatically without anyone re-typing information by hand.

Common Questions

Do I Need a Different API Key for Each Integration?
It is a good idea, yes. AccuLynx lets you generate more than one key, and giving each tool its own makes it easy to turn one connection off later without affecting the others.

What If I Do Not See "API Keys" in My Account Settings?
That usually means either the AppConnections add-on is not enabled on your account, or your login does not have administrator access. Check with whoever manages your AccuLynx account to sort out which one it is.

What Happens If I Lose the Key After I Copy It?
AccuLynx generally will not show you the full key again once you leave that screen. The fix is simple: create a new key and update the connected tool with it, then remove the old one from your list.

Still have a question this didn't answer? Reach out to our support team support@alivo.ai and we'll be glad to help.