API keys allow you to integrate Togetherly with your CRM, mobile apps, and other external systems. This guide will walk you through creating and managing API keys for your organization. ## Prerequisites - You must be an administrator for your organization - Your organization must have the Integrations & API feature enabled ## Steps ### Step 1: Navigate to API Keys Settings From your Togetherly dashboard, click on your organization name in the top navigation bar to access the settings menu. In the left sidebar, locate and click on 'Integrations / API' which is marked with a key icon. This will take you to the API Keys management page where you can view and manage all your organization's API keys. ![Navigate to API Keys Settings](https://help.together.ly/rails/active_storage/blobs/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTM2LCJwdXIiOiJibG9iX2lkIn19--f391136a14c2c528e168f7a4d40b356dc4548bc3/step_0.png) ### Step 2: Click New API Key On the API Keys page, you'll see a table listing any existing API keys your organization has created. In the top-right corner of the page, click the 'New API Key' button to begin creating a new API key. ![Click New API Key](https://help.together.ly/rails/active_storage/blobs/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTM3LCJwdXIiOiJibG9iX2lkIn19--27d67bed5a3ce9daa4364731535bc9ec41d10050/step_1.png) ### Step 3: Enter a Description A dialog box will appear asking you to provide a description for your new API key. Enter a meaningful description that helps you identify what this key will be used for, such as 'CRM Integration', 'Mobile App', or 'Reporting Dashboard'. This description will be displayed in the API keys table and helps your team understand the purpose of each key. ![Enter a Description](https://help.together.ly/rails/active_storage/blobs/proxy/eyJfcmFpbHMiOnsiZGF0YSI6MTM4LCJwdXIiOiJibG9iX2lkIn19--dbc501170234f5dfb08076e97bfda01dc1e4d878/step_2.png) ### Step 4: Create and Copy the API Key Click the 'Create API Key' button to generate your new key. The page will refresh and your new API key will appear in the table. The key is a unique identifier (UUID format) that looks like 'a3f7c2d1-8e4b-4a9c-b5e6-1d2f3a4b5c6d'. Click the clipboard icon next to the key to copy it to your clipboard. Store this key securely - you'll need to provide it when configuring your external systems to connect to Togetherly. ### Step 5: Use the API Key in Your Integration When making API requests to Togetherly, include your API key in the request headers for authentication. Refer to Togetherly's API documentation for specific endpoints and usage instructions. Your API key identifies your organization and authorizes access to your data. ### Step 6: Delete API Keys When No Longer Needed If an API key is compromised or no longer needed, you can revoke it by clicking the red 'Delete' button next to the key in the API keys table. A confirmation dialog will appear to prevent accidental deletion. Once deleted, any systems using that key will immediately lose access. You can create a new key if needed. ## Tips - Create separate API keys for each integration or system to make it easier to track usage and revoke access if needed - Store API keys securely and never commit them to public code repositories or share them in unsecured channels - Use descriptive names for your API keys so your team can easily identify which systems are using which keys ## Summary You now know how to create, copy, and manage API keys for integrating Togetherly with external systems. Remember to keep your API keys secure and delete any keys that are no longer in use to maintain security.