Lead Fuel CRM
    Knowledge BaseSettings and AdministrationAPI Access
    Settings and Administration

    API Access

    Settings & Administration

    API Access

    Overview

    API Access enables developers to integrate Lead Fuel CRM with external applications and build custom automations using our RESTful API. Generate API keys, manage access permissions, monitor usage, and authenticate your applications. This section covers everything needed to programmatically interact with your CRM data.

    Generating API Keys

    Create API credentials for your applications:

    Step 1:Go to Settings > API Access > API Keys
    Step 2:Click "Generate New API Key"
    Step 3:Enter a descriptive name for your application (e.g., "Sales Dashboard Integration")
    Step 4:Select scopes (permissions) your application requires
    Step 5:Choose an expiration period (30, 90, 180 days, or no expiration)
    Step 6:Click "Generate" and copy the key immediately (only displayed once)
    Step 7:Store the key securely in your environment variables or secrets manager

    Important: API keys are displayed only once. Store them immediately in a secure location. If lost, delete and regenerate the key.

    API Scopes & Permissions

    Define what resources your API key can access:

    • contacts:read: Read-only access to all contacts and contact fields
    • contacts:write: Create, update, and delete contacts
    • deals:read: Read access to all pipeline stages and deal data
    • deals:write: Create and modify deals and pipeline stages
    • activities:read: View activity logs and timeline events
    • activities:write: Create and log activities and notes
    • automations:read: Access automation configurations and performance data
    • automations:write: Create, modify, and trigger automations
    • users:read: List team members and their information
    • reports:read: Access reporting and analytics data

    API Documentation

    Access comprehensive API documentation:

    • Visit https://developer.leadfuelcrm.com/docs for complete API reference
    • View endpoint specifications, request/response examples, and error codes
    • Browse code samples in Python, JavaScript, PHP, and other languages
    • Test endpoints directly in the interactive API explorer
    • Review webhook documentation for event-driven integrations

    Rate Limiting & Usage

    Rate Limits

    API access is throttled to ensure platform stability:

    Monitoring Usage

    Step 1:Navigate to Settings > API Access > Usage
    Step 2:View current hour and month request counts
    Step 3:See graphs of API requests over time
    Step 4:Identify which endpoints are most frequently called
    Step 5:Set up alerts if approaching rate limits

    API Authentication

    Include your API key in request headers:

    Step 1:Add header: Authorization: Bearer YOUR_API_KEY
    Step 2:Include Content-Type: application/json header
    Step 3:Send requests to https://api.leadfuelcrm.com/v1/[endpoint]
    Step 4:Handle authentication errors (401) by verifying your API key is current and not expired

    Webhook Configuration

    Receive real-time notifications when events occur in your CRM:

    • Webhook URL: Your application endpoint that receives event notifications
    • Event Types: Subscribe to specific events: contact.created, deal.won, automation.triggered
    • Retry Policy: Webhooks retry up to 5 times if your endpoint is unreachable
    • Signature Verification: Verify webhook authenticity using HMAC-SHA256 signature

    Tip: Use the webhook tester at https://developer.leadfuelcrm.com/webhook-simulator to test your webhook implementation without needing to deploy.

    Need more help? Contact Lead Fuel CRM support for personalized assistance.

    Have a question or want to connect with other Lead Fuel users? Join the Lead Fuel VIP Facebook Group

    Previous

    Branding Settings

    Next

    Custom Objects