Create and manage keys that third-party apps and services require to integrate with Connect. Access the supporting documentation

1. Login into CRF Connect: https://connect.crfusa.com/app/

2. Click on the 'Integrations' tab on the left-hand menu bar:

3. Click on 'Create API Key' to create a new API Key:

NOTE: Slugs & Root Endpoints

From the 'Integrations' page is where you can retrieve the partner-specific 'Slug' component of the URL & also the 'Root Endpoint' which is used in path /api/v1/slug... 

4. Enter an API Key Name with Tags (optional) & set permissions and expiration date for the API Key:

Permissions are as follows:

export:leads Lead exports which have been generated can be downloaded via the API if the API key has permission.

read:leads Enables the API key to read lead metadata via API.

write:submissions Enables referral partners to create submissions via API.

write:leads Enables service partners to update their leads stage progression via API.

5. Click on "Generate Key" to generate the new API Key:

6. Your new API Key and Partner ID will be generated as seen below:

IMPORTANT NOTE: Please copy the key above and store it somewhere secure.

This key is non-recoverable once you click the close button. If you lose this key, you will need to create a new one.

7. You will be able to Manage your API Keys by refreshing or deleting them on the 'Integrations" page within Connect:

API & Integrations Document Guides: CRF Connect Integration