Getting Started

The Leadfeeder API enables you to programmatically access company and contact intelligence, website visitor data, and manage your workflow objects. This guide walks you through the initial setup to start making your first API requests.

Prerequisites

Before you begin, ensure you have:

An active Leadfeeder account

User permissions to generate API keys

A development environment capable of making HTTPS requests

Step 1: Generate Your API Key

Each Leadfeeder user can generate their own API keys for authentication.

To create an API key:

Navigate to Settings ⚙ → Personal → API Keys

Click Create a new API key

Copy and securely store your API key

Note: If you do not see the API keys section, contact your account administrator to grant the necessary permissions.

For detailed information on how to configure authentication in your requests, see Authentication.

Step 2: Find Your Account ID

Most API endpoints require an account_id parameter to specify which account's data you want to access. Your user may have access to multiple Leadfeeder accounts.

List All Accounts

Use the List Accounts endpoint to retrieve all accounts accessible with your API key:

Request

Response

{
  "data": [
    {
      "type": "account_summary",
      "id": "123456",
      "attributes": {
        "name": "Account 1"
      }
    },
    {
      "type": "account_summary",
      "id": "789012",
      "attributes": {
        "name": "Account 2"
      }
    }
  ],
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

The id field contains your account_id.

Get Account Details with Credit Information#

To retrieve detailed information about a specific account, including credit usage:

Request

Response

{
  "data": [
    {
      "type": "account",
      "id": "123456",
      "attributes": {
        "name": "Account 1",
        "credits": {
          "available": 1000,
          "used": 200,
          "remaining": 800,
          "next_reset_on": "2026-10-01"
        }
      }
    }
  ],
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Step 3: Make Your First API Request

Once you have your API key and account ID, you can start making requests to the API.

Example: Search for Companies

Let's search for companies in a specific location and industry:

Request

Response

{
  "data": [
    {
      "type": "company_summary",
      "id": "159001425",
      "attributes": {
        "name": "Example Company Ltd",
        "role": "group_member",
        "register": {
          "status": "active"
        },
        "meta": {
          "do_not_contact": false,
          "has_phones": true,
          "has_mail": true,
          "has_contacts": true
        }
      }
    }
  ],
  "meta": {
    "credits": {
      "charged": 0
    },
    "pagination": {
      "next_cursor": "dXNlcjpVMEc5V0ZYTlo",
      "total_count": 145
    },
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Understanding the `account_id` Parameter

The account_id is a required parameter for most API endpoints. It determines:

Which account's data is accessed

Which credit pool is used for requests that consume credits

Which permissions and access levels apply

Prerequisites#

Step 1: Generate Your API Key#

Step 2: Find Your Account ID#

List All Accounts#

Get Account Details with Credit Information##

Step 3: Make Your First API Request#

Example: Search for Companies#

Understanding the account_id Parameter#

Prerequisites

Step 1: Generate Your API Key

Step 2: Find Your Account ID

List All Accounts

Get Account Details with Credit Information#

Step 3: Make Your First API Request

Example: Search for Companies

Understanding the `account_id` Parameter