Skip to main content

 

Kareo Help Center

API Customer Key

Before you can connect Kareo to a third-party app, you'll need to locate your Customer Key. As an added security measure, Kareo SOAP API requires the use of a Customer Key (in addition to your login and password) to access your data. A Customer Key is an account-specific identifier that is the same for all users on the account. The Key never changes or expires.  

Note: The Customer Key is only required when pairing Kareo Desktop Application with a partner EHR.

 

Get Customer Key

  1. Click Help > Get Customer Key. The Get Customer Key page opens in a browser.
Desktop_CustomerKey.png
  1. Click Create my customer key. The customer key will generate and show next to Your key.

Once the customer key is generated, users can access the key again by going to Get Customer Key.

Desktop_CustomerKey_Show.png

Enable API Access

Once you have the customer key, a System Admin must follow the steps below to enable API access for your user.

  1. Click Settings > User Accounts. The User Account window opens.
  2. Click on the user's name. The Account Details window opens.
Settings_UserAccount.png
  1. Click on the Permissions tab.
  2. Click to select "Full Control" for EHRs & API.
  3. Click Save Changes.
Settings_UserAccount_API.png

 

  • Was this article helpful?