What Are API Keys?
API keys are unique credentials that allow external applications to:- Read property and package data
- Create and update deals
- Access contact information
- Trigger webhooks
Generating an API Key
- Navigate to Agency Settings → Integrations → API
- Click Generate New Key
- Enter a descriptive name (e.g., “Website Integration”, “CRM Sync”)
- Select the permissions for this key
- Click Create
- Copy the key immediately: it won’t be shown again
API Key Permissions
When creating a key, choose what it can access:Managing Keys
Viewing Active Keys
- Go to Agency Settings → Integrations → API
- See all active keys with their names and creation dates
- Permissions are displayed for each key
Revoking a Key
- Find the key in the list
- Click Revoke or the delete icon
- Confirm the action
Security Best Practices
- Never share keys publicly: Treat them like passwords
- Use descriptive names: Know what each key is used for
- Minimum permissions: Only grant what’s needed
- Rotate regularly: Replace keys periodically
- Revoke unused keys: Remove keys no longer in use
Tips
- Create separate keys for each integration
- Test with read-only keys first
- Monitor API usage for unusual activity
- Document which systems use which keys