API Keys

To use the CTM API, your account must have both an API Key and a Secret Key. These credentials are also required for certain integrations.

To enable API access and retrieve your keys, go to your account's API Integration settings.

Account Only API Key Setup

1. Navigate to Settings > Account Settings.
2. Click API Integration in the left-hand navigation, or scroll down to the section.
3. Click Enable API Access.
4. Once access is enabled, your Access Key and Secret Key will be displayed on the screen. You will need to click Show Secret Key to copy/paste the Secret Key.

Agency API Keys Setup

If you need to make API requests for your entire agency rather than a single account, you can also enable Agency API Keys. 

1. Navigate to Settings > Parent Settings.
2. Click API Integration in the left-hand navigation, or scroll down to the section.
3. Click Enable API Access.
4. Once access is enabled, your Access Key and Secret Key will be displayed on the screen. You will need to click Show Secret Key to copy/paste the Secret Key.

Resetting API Access

If your keys have been compromised or shared unintentionally, or if you want to rotate them for security purposes, you can reset them at any time.

1. Go to the API Integration section in either Account or Agency settings.
2. Scroll to the bottom of the API Integration section. 
3. Click Reset API Access.
4. A confirmation window will appear. Click Reset API Access again to confirm.
5. The page will reload, and a new Access Key and Secret Key will be generated.

Note: Resetting your keys will immediately invalidate the old ones. Any integrations using the previous keys will stop working until updated with the new credentials.