Skip to content
OpenAPI 3.1 reference

LeadFuze API reference

Search, enrich, verify and deliver B2B contact data from 269M+ US profiles over one REST API. Every product on this page uses the same API key, and API access comes with every plan.

This page is drawn from our OpenAPI file. Load the same file into Postman, Insomnia or a code generator and you have every endpoint, parameter and example ready to call.

Base URLhttps://console.leadfuze.com/api/v1
AuthAuthorization: Bearer YOUR_API_KEY
FormatJSON in, JSON out
Rate limit1,000 requests a minute
Your first call
curl "https://console.leadfuze.com/api/v1/leads-database/catalog" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"

Authentication

Create an API key in the LeadFuze app under API keys and send it as a Bearer token on every request. Keys can be turned off at any time. For a file download opened in a browser, pass it as an api_key query parameter instead.

Keep keys on your server. Anyone with a key can spend your credits.

Header
Authorization: Bearer YOUR_API_KEY

Credits

Searching, counting and paging the lead database are free. You use a credit when you reveal or export a person, enrich a record, verify an email or validate a phone. No match costs nothing, and the same person again within 30 days is free. Intent Scans come from the scans in your plan.

Need every record in your own cloud instead? The data license delivers the full graph to an AWS S3 bucket each month.

Credits in a response
{
  "credits": {
    "remaining": 24812,
    "free_remaining": 0,
    "paid_remaining": 24812
  }
}

Errors and limits

200, 201, 202It worked. 202 means a background job has started.
401Missing, invalid or inactive API key.
402Out of credits for this product.
404Not found, or it belongs to another account.
409Not ready yet, for example an export still running.
422Validation failed. errors lists each field and what to fix.
429More than 1,000 requests in a minute. Wait and retry.
Limits
Lead database page size1 to 50, default 25
Revealup to 100 people a call
Exportup to 100,000 rows
Cursor life14 minutes
Saved searcheskept 30 days
Bulk filesCSV up to 50MB
Bulk verify or validate100 a call, or a file
422 response
{
  "message": "Use at most 200 included and excluded values across filters.",
  "errors": {
    "filters": ["Use at most 200 included and excluded values across filters."]
  }
}

Use it from AI tools

The LeadFuze MCP server gives Claude, Cursor and other MCP clients email and LinkedIn enrichment, email validation and company lookup, on the same credits as the API.

MCP server URL
https://mcp.leadfuze.com/mcp
Lead database

Lead database API

Search 269M+ US profiles with the same filters as the LeadFuze app. Searching, counting and paging are free and show who matches and what contact details are on file. You spend a credit only when you reveal or export a record.

How a search works

  1. Read the catalog once. GET /leads-database/catalog lists every field you can filter on and its allowed values.
  2. Size the market. POST /leads-database/count returns how many people match. Free.
  3. Start the search. POST /leads-database/search returns the first page of previews and a next_cursor. Free.
  4. Page through. GET /leads-database/searches/{search}/pages/{cursor}. Free.
  5. Pay only for what you keep. Reveal up to 100 people at a time, or export up to 100,000 to CSV or Excel. One credit per person, and the same person again within 30 days is free.

Include, exclude and match

  • Different fields combine with AND. Values inside one include list combine with OR. A match on any exclude value removes the person.
  • Each list takes up to 20 values, and a search takes up to 200 include and exclude values in total.
  • match: "exact" compares the whole value, ignoring case. match: "phrase" finds whole words inside the text, and works on job_title, company_name, work_history, education_history, company_description and social_connections. Phrase is the default for the last four.
  • presence: "has" keeps only people with that field on file, and "missing" only people without it. A person with no value passes an exclude-only rule, so add presence: "has" when the value must exist.
  • State names become codes (Texas becomes TX), and country codes are uppercased.

Job titles and title groups

job_titles matches whole words and phrases inside the job title. Any include phrase is enough; any exclude phrase removes the person, so a title group is simply a list of phrases to include and a list to exclude:

  • Owners: include Owner, Founder, Co-Founder, Partner; exclude Vice, Assistant, Product.
  • Operations leaders: include VP of Operations, Director of Operations, Head of Operations.

With similar on (the default), common variants are added for you: CEO and Chief Executive Officer, VP of Sales and Vice President of Sales, Founder and Co-Founder. At most 20 titles after expansion.

Filter groups

The catalog sorts every filter into a group: Person and work, Company, Location and personal, Contact availability (the on-file filters, such as has_mobile_phone) and Identifiers (up_id, cc_id).

  • Shortcut filters: state (work state, otherwise company state), country, industry, department, seniority and company_size.
  • Combined on-file filters: has_any_email, has_any_phone and has_personal_email.
Example criteria
{
  "query": "",
  "job_titles": {
    "include": ["VP of Operations", "Director of Operations"],
    "exclude": ["Assistant"],
    "similar": true
  },
  "filters": {
    "primary_industry": {
      "include": ["Truck Transportation", "Warehousing And Storage"]
    },
    "company_employee_count": {
      "include": ["101 to 250", "251 to 500"]
    },
    "state": {
      "include": ["Texas", "OK"]
    },
    "company_description": {
      "include": ["cold chain"],
      "match": "phrase"
    },
    "company_domain": {
      "exclude": ["competitor.com"]
    },
    "mobile_phone": {
      "presence": "has"
    },
    "has_business_email": {
      "value": true
    }
  },
  "limit": 25
}
In plain English
  • Title contains VP of Operations or Director of Operations (plus variants), but not Assistant
  • Industry is Truck Transportation or Warehousing And Storage
  • 101 to 500 employees
  • Works in Texas or Oklahoma
  • Company description mentions cold chain
  • Not at competitor.com
  • Mobile phone and business email on file
GET/leads-database/catalog

List the filterable fields

Every field you can filter on, with its group, whether it is an on-file (boolean) filter, whether it supports phrase matching and on-file presence, an example, and the allowed values where the list is fixed. Read it once and cache it.

Responses
200OK
fieldsCatalogField[]
Show 9 child attributes
keystring
labelstring
groupstring
Person and workCompanyLocation and personalContact availabilityIdentifiers
booleanboolean
phraseboolean
presenceboolean
descriptionstring
exampleobject
choicesstring[]
credits_remaininginteger
max_exportinteger
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X GET "https://console.leadfuze.com/api/v1/leads-database/catalog" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/catalog', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/leads-database/catalog",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "fields": [
    {
      "key": "company_employee_count",
      "label": "Company Employee Count",
      "group": "Company",
      "boolean": false,
      "phrase": false,
      "description": "Exact normalized value from this source column.",
      "example": "1001 to 5000",
      "choices": [
        "1 to 10",
        "11 to 25",
        "26 to 50",
        "51 to 100",
        "101 to 250",
        "251 to 500",
        "501 to 1000",
        "1001 to 5000",
        "5001 to 10000",
        "10000+"
      ],
      "presence": true
    },
    {
      "key": "has_mobile_phone",
      "label": "Has Mobile Phone",
      "group": "Contact availability",
      "boolean": true,
      "phrase": false,
      "description": "Whether mobile_phone has a usable value.",
      "example": true,
      "choices": [],
      "presence": false
    }
  ],
  "credits_remaining": 24812,
  "max_export": 100000
}
POST/leads-database/count

Count the people who match

Takes the same criteria as a search and returns only the total. Use it to size a market before you spend anything. Free.

Request body application/json
querystring

Free text across name, job title, company name, industry, city and state. A complete email, phone, domain or LinkedIn URL runs an exact lookup.

max length 500, default ""
lookup_typestring or null

Force an exact lookup of query. email checks all five email columns; phone all four phone columns; id uses up_id.

emailphonedomainlinkedinid
job_titlesJobTitles
Show 3 child attributes
includestring[]

Whole words or phrases matched inside job_title. Any one is enough.

max items 20
excludestring[]

Remove titles containing any of these. Overrides include.

max items 20
similarboolean

Also match common variants: CEO and Chief Executive Officer, VP of X and Vice President of X, Founder and Co-Founder. At most 20 titles after expansion.

default true
filtersobject

Keyed by catalog field. At most 200 include and exclude values across all filters.

Show filter value shapes

One key per catalog field (see all fields). Fields that start with has_ take an AvailabilityFilter. Every other field takes a FieldCondition.

FieldCondition
includestring[]

Keep people whose value matches any of these.

max items 20
excludestring[]

Remove people whose value matches any of these. A person with no value passes an exclude-only rule.

max items 20
matchstring

exact compares the whole value, ignoring case. phrase finds whole words inside the text and works on job_title, company_name, work_history, education_history, company_description, social_connections. Default phrase for work_history, education_history, company_description, social_connections, exact for the rest.

exactphrase
presencestring

Only people with this field on file, or only people without it.

hasmissing
AvailabilityFilter
valuebooleanrequired
limitinteger

Results per page.

min 1, max 50, default 25
Responses
200OK
totalinteger or null
total_is_exactboolean
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X POST "https://console.leadfuze.com/api/v1/leads-database/count" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "",
    "job_titles": {
      "include": ["VP of Operations", "Director of Operations"],
      "exclude": ["Assistant"],
      "similar": true
    },
    "filters": {
      "primary_industry": {
        "include": ["Truck Transportation", "Warehousing And Storage"]
      },
      "company_employee_count": {
        "include": ["101 to 250", "251 to 500"]
      },
      "state": {
        "include": ["Texas", "OK"]
      },
      "company_description": {
        "include": ["cold chain"],
        "match": "phrase"
      },
      "company_domain": {
        "exclude": ["competitor.com"]
      },
      "mobile_phone": {
        "presence": "has"
      },
      "has_business_email": {
        "value": true
      }
    },
    "limit": 25
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/count', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "query": "",
    "job_titles": {
      "include": ["VP of Operations", "Director of Operations"],
      "exclude": ["Assistant"],
      "similar": true
    },
    "filters": {
      "primary_industry": {
        "include": ["Truck Transportation", "Warehousing And Storage"]
      },
      "company_employee_count": {
        "include": ["101 to 250", "251 to 500"]
      },
      "state": {
        "include": ["Texas", "OK"]
      },
      "company_description": {
        "include": ["cold chain"],
        "match": "phrase"
      },
      "company_domain": {
        "exclude": ["competitor.com"]
      },
      "mobile_phone": {
        "presence": "has"
      },
      "has_business_email": {
        "value": true
      }
    },
    "limit": 25
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/leads-database/count",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "query": "",
        "job_titles": {
            "include": ["VP of Operations", "Director of Operations"],
            "exclude": ["Assistant"],
            "similar": True
        },
        "filters": {
            "primary_industry": {
                "include": ["Truck Transportation", "Warehousing And Storage"]
            },
            "company_employee_count": {
                "include": ["101 to 250", "251 to 500"]
            },
            "state": {
                "include": ["Texas", "OK"]
            },
            "company_description": {
                "include": ["cold chain"],
                "match": "phrase"
            },
            "company_domain": {
                "exclude": ["competitor.com"]
            },
            "mobile_phone": {
                "presence": "has"
            },
            "has_business_email": {
                "value": True
            }
        },
        "limit": 25
    },
)
print(r.json())
Response200application/json
{
  "total": 18420,
  "total_is_exact": true
}
GET/leads-database/searches/{search}/pages/{cursor}

Get the next page

Pass the next_cursor from the previous page. Returns the same shape as a search, with a new next_cursor until the results run out. Free.

Path parameters
searchstring (uuid)required

The search_id from POST /leads-database/search.

cursorstring (uuid)required

next_cursor from the previous page.

Responses
200OK
successboolean
search_idstring (uuid)
criteriaCriteria

Who to find. Fields are combined with AND; values inside one include list with OR; any exclude removes a person.

Show 5 child attributes
querystring

Free text across name, job title, company name, industry, city and state. A complete email, phone, domain or LinkedIn URL runs an exact lookup.

max length 500, default ""
lookup_typestring or null

Force an exact lookup of query. email checks all five email columns; phone all four phone columns; id uses up_id.

emailphonedomainlinkedinid
job_titlesJobTitles
Show 3 child attributes
includestring[]

Whole words or phrases matched inside job_title. Any one is enough.

max items 20
excludestring[]

Remove titles containing any of these. Overrides include.

max items 20
similarboolean

Also match common variants: CEO and Chief Executive Officer, VP of X and Vice President of X, Founder and Co-Founder. At most 20 titles after expansion.

default true
filtersobject

Keyed by catalog field. At most 200 include and exclude values across all filters.

Show filter value shapes

One key per catalog field (see all fields). Fields that start with has_ take an AvailabilityFilter. Every other field takes a FieldCondition.

FieldCondition
includestring[]

Keep people whose value matches any of these.

max items 20
excludestring[]

Remove people whose value matches any of these. A person with no value passes an exclude-only rule.

max items 20
matchstring

exact compares the whole value, ignoring case. phrase finds whole words inside the text and works on job_title, company_name, work_history, education_history, company_description, social_connections. Default phrase for work_history, education_history, company_description, social_connections, exact for the rest.

exactphrase
presencestring

Only people with this field on file, or only people without it.

hasmissing
AvailabilityFilter
valuebooleanrequired
limitinteger

Results per page.

min 1, max 50, default 25
dataLeadPreview[]
Show 18 child attributes
up_idstring or null
first_namestring or null
last_namestring or null
job_titlestring or null
seniority_levelstring or null
departmentstring or null
company_namestring or null
company_domainstring or null
company_employee_countstring or null
company_revenuestring or null
primary_industrystring or null
professional_citystring or null
professional_statestring or null
company_citystring or null
company_statestring or null
countrystring or null
on_fileobject
verified_business_emailboolean
totalinteger or null
total_is_exactboolean
next_cursorstring or null
cursor_expires_atstring (date-time) or null
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/leads-database/searches/3f6c2a8e-1b7d-4c55-9e0a-6d2f8b41c9a7/pages/9b2e7d10-5a3c-4f8e-b1d6-2c7a9e4f0b13" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/searches/3f6c2a8e-1b7d-4c55-9e0a-6d2f8b41c9a7/pages/9b2e7d10-5a3c-4f8e-b1d6-2c7a9e4f0b13', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/leads-database/searches/3f6c2a8e-1b7d-4c55-9e0a-6d2f8b41c9a7/pages/9b2e7d10-5a3c-4f8e-b1d6-2c7a9e4f0b13",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true,
  "search_id": "3f6c2a8e-1b7d-4c55-9e0a-6d2f8b41c9a7",
  "criteria": {
    "query": "",
    "filters": {
      "company_description": {
        "include": ["cold chain"],
        "exclude": [],
        "match": "phrase"
      },
      "company_domain": {
        "include": [],
        "exclude": ["competitor.com"],
        "match": "exact"
      },
      "company_employee_count": {
        "include": ["101 to 250", "251 to 500"],
        "exclude": [],
        "match": "exact"
      },
      "has_business_email": {
        "value": true
      },
      "mobile_phone": {
        "include": [],
        "exclude": [],
        "match": "exact",
        "presence": "has"
      },
      "primary_industry": {
        "include": ["Truck Transportation", "Warehousing And Storage"],
        "exclude": [],
        "match": "exact"
      },
      "state": {
        "include": ["TX", "OK"],
        "exclude": [],
        "match": "exact"
      }
    },
    "job_titles": {
      "include": ["VP of Operations", "Director of Operations"],
      "exclude": ["Assistant"],
      "similar": true
    },
    "lookup_type": null,
    "limit": 25
  },
  "data": [
    {
      "up_id": "up_8c41d2e7a9",
      "first_name": "Dana",
      "last_name": "Whitfield",
      "job_title": "VP of Operations",
      "seniority_level": "Vp",
      "department": "Operations",
      "company_name": "Northline Logistics",
      "company_domain": "northlinelogistics.com",
      "company_employee_count": "251 to 500",
      "company_revenue": "50 Million to 100 Million",
      "primary_industry": "Truck Transportation",
      "professional_city": "Austin",
      "professional_state": "TX",
      "company_city": "Austin",
      "company_state": "TX",
      "country": "US",
      "on_file": {
        "business_email": true,
        "personal_emails": true,
        "mobile_phone": true,
        "personal_phone": true,
        "direct_number": true,
        "linkedin_url": true
      },
      "verified_business_email": true
    }
  ],
  "total": 18420,
  "total_is_exact": true,
  "next_cursor": "1c7e9a2f-4b3d-4e8a-9f05-6d2c8b1a7e40",
  "cursor_expires_at": "2026-10-27T15:32:11+00:00"
}
POST/leads-database/searches/{search}/reveal

Reveal full records

Returns every field for up to 100 people from this search. One credit per person; revealing the same person again within 30 days is free. Answers 402 when you are out of credits.

1 credit per new person
Path parameters
searchstring (uuid)required

The search_id from POST /leads-database/search.

Request body application/json
idsstring[]required

1 to 100 up_id values returned by this search.

Responses
200OK
successboolean
dataLeadRecord[]
credits_usedinteger
credits_remaininginteger
limited_by_creditsboolean
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/leads-database/searches/3f6c2a8e-1b7d-4c55-9e0a-6d2f8b41c9a7/reveal" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["up_8c41d2e7a9"]
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/searches/3f6c2a8e-1b7d-4c55-9e0a-6d2f8b41c9a7/reveal', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ids": ["up_8c41d2e7a9"]
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/leads-database/searches/3f6c2a8e-1b7d-4c55-9e0a-6d2f8b41c9a7/reveal",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "ids": ["up_8c41d2e7a9"]
    },
)
print(r.json())
Response200application/json
{
  "success": true,
  "data": [
    {
      "up_id": "up_8c41d2e7a9",
      "cc_id": "cc_51b9e0a4f2",
      "first_name": "Dana",
      "last_name": "Whitfield",
      "linkedin_url": "linkedin.com/in/danawhitfield",
      "social_connections": "500+",
      "job_title": "VP of Operations",
      "job_title_normalized": "vice president of operations",
      "seniority_level": "Vp",
      "seniority_level_2": "vice president",
      "department": "Operations",
      "department_2": "operations",
      "business_email": "dana@northlinelogistics.com",
      "business_email_validation_status": "Valid (Esp)",
      "programmatic_business_emails": "dana.whitfield@northlinelogistics.com",
      "historical_programmatic_emails": "dwhitfield@ridgewayfreight.com",
      "mobile_phone": "15125550148",
      "direct_number": "+15125550190",
      "personal_phone": "+15125550173",
      "personal_emails": "danawhitfield@gmail.com",
      "additional_personal_emails": "dana.w4@yahoo.com",
      "personal_emails_validation_status": "Valid (Esp)",
      "company_name": "Northline Logistics",
      "company_domain": "northlinelogistics.com",
      "related_domains": "northline.io",
      "company_description": "Regional freight and warehousing for retailers",
      "primary_industry": "Truck Transportation",
      "company_sic": "4213",
      "company_naics": "484121",
      "company_employee_count": "251 to 500",
      "company_revenue": "50 Million to 100 Million",
      "company_phone": "+15125550100",
      "company_linkedin_url": "linkedin.com/company/northlinelogistics",
      "company_address": "400 Commerce Way",
      "company_city": "Austin",
      "company_state": "TX",
      "company_zip": "78744",
      "company_country": "US",
      "professional_address": "400 Commerce Way",
      "professional_address_2": "Suite 210",
      "professional_city": "Austin",
      "professional_state": "TX",
      "professional_zip": "78744",
      "professional_zip4": "1207",
      "contact_country": "US",
      "personal_address": "1180 Oak Ridge Dr",
      "personal_address_2": null,
      "personal_city": "Round Rock",
      "personal_state": "TX",
      "personal_zip": "78681",
      "personal_zip4": "3342",
      "dpv_code": "Y",
      "gender": "F",
      "age_range": "45-54",
      "dob": null,
      "married": "Y",
      "children": "Y",
      "homeowner": "Y",
      "income_range": "$150,000 to $199,999",
      "net_worth": "$500,000 to $749,999",
      "work_history": "Director of Operations, Ridgeway Freight, 2014 to 2019",
      "education_history": "University of Texas, BS, Business Administration"
    }
  ],
  "credits_used": 1,
  "credits_remaining": 24811,
  "limited_by_credits": false
}
POST/leads-database/exports

Export a search to a file

Queues an export of chosen people, or of every match, up to 100,000 rows. Send an Idempotency-Key header so a retry never creates a second export. Answers 202; poll the export until download_ready is true.

1 credit per new person exported
Headers
Idempotency-Keystringrequired

Any stable unique string for this export.

Request body application/json
search_idstring (uuid)required

The search to export from.

namestring

A name for the file, up to 80 characters.

allboolean

Export every match instead of a list of ids.

idsstring[]

Up to 1,000 up_id values to export.

exclude_idsstring[]

With all, up to 1,000 up_id values to leave out.

max_resultsinteger

Stop after this many rows, 1 to 100,000.

Responses
202Accepted
idstring (uuid)
namestring or null
statusstring
queuedrunningdonepartialfailedcanceled
max_resultsinteger
exported_countinteger
credits_usedinteger
error_codestring or null
created_atstring (date-time)
download_readyboolean
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/leads-database/exports" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Idempotency-Key: texas-ops-2026-10-27" \
  -H "Content-Type: application/json" \
  -d '{
    "search_id": "3f6c2a8e-1b7d-4c55-9e0a-6d2f8b41c9a7",
    "name": "Texas freight operations leaders",
    "all": true,
    "max_results": 5000
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/exports', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Idempotency-Key': 'texas-ops-2026-10-27',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "search_id": "3f6c2a8e-1b7d-4c55-9e0a-6d2f8b41c9a7",
    "name": "Texas freight operations leaders",
    "all": true,
    "max_results": 5000
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/leads-database/exports",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}", "Idempotency-Key": "texas-ops-2026-10-27"},
    json={
        "search_id": "3f6c2a8e-1b7d-4c55-9e0a-6d2f8b41c9a7",
        "name": "Texas freight operations leaders",
        "all": True,
        "max_results": 5000
    },
)
print(r.json())
Response202application/json
{
  "id": "c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41",
  "name": "Texas freight operations leaders",
  "status": "queued",
  "max_results": 5000,
  "exported_count": 0,
  "credits_used": 0,
  "error_code": null,
  "created_at": "2026-10-27T15:04:05.000000Z",
  "download_ready": false
}
GET/leads-database/exports

List exports

The latest 100 exports with status and counts.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X GET "https://console.leadfuze.com/api/v1/leads-database/exports" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/exports', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/leads-database/exports",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "data": []
}
GET/leads-database/exports/{export}

Check an export

Status is queued, running, done, partial (stopped when credits ran out), failed or canceled.

Path parameters
exportstring (uuid)required

The export id.

Responses
200OK
idstring (uuid)
namestring or null
statusstring
queuedrunningdonepartialfailedcanceled
max_resultsinteger
exported_countinteger
credits_usedinteger
error_codestring or null
created_atstring (date-time)
download_readyboolean
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "id": "c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41",
  "name": "Texas freight operations leaders",
  "status": "done",
  "max_results": 5000,
  "exported_count": 5000,
  "credits_used": 4870,
  "error_code": null,
  "created_at": "2026-10-27T15:04:05.000000Z",
  "download_ready": true
}
DELETE/leads-database/exports/{export}

Cancel an export

Stops a queued or running export.

Path parameters
exportstring (uuid)required

The export id.

Responses
200OK
idstring (uuid)
namestring or null
statusstring
queuedrunningdonepartialfailedcanceled
max_resultsinteger
exported_countinteger
credits_usedinteger
error_codestring or null
created_atstring (date-time)
download_readyboolean
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X DELETE "https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.delete(
    "https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "id": "uuid",
  "name": "string",
  "status": "queued",
  "max_results": 0,
  "exported_count": 0,
  "credits_used": 0,
  "error_code": "string",
  "created_at": "date-time",
  "download_ready": true
}
GET/leads-database/exports/{export}/download

Download an export

Streams the file with up_id, cc_id and every field as columns. Pass api_key as a query parameter when a browser does the download.

Path parameters
exportstring (uuid)required

The export id.

Query parameters
formatstring

csv (default) or xlsx.

Responses
200The file.
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41/download" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41/download', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.text();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41/download",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.text)
Response200text/csv
up_id,cc_id,first_name,last_name,job_title,company_name,business_email,mobile_phone,...
up_8c41d2e7a9,cc_51b9e0a4f2,Dana,Whitfield,VP of Operations,Northline Logistics,dana@northlinelogistics.com,15125550148,...
POST/leads-database/parse

Turn a sentence into criteria

Describe who you want in plain English and get criteria back to review before you search. Words it cannot map are returned in unmapped and are not applied.

Request body application/json
descriptionstringrequired

Up to 2,000 characters.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X POST "https://console.leadfuze.com/api/v1/leads-database/parse" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "VPs of operations at trucking companies in Texas with a mobile phone"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/parse', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "description": "VPs of operations at trucking companies in Texas with a mobile phone"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/leads-database/parse",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "description": "VPs of operations at trucking companies in Texas with a mobile phone"
    },
)
print(r.json())
Response200application/json
{
  "criteria": {
    "query": "",
    "filters": {
      "has_mobile_phone": {
        "value": true
      },
      "primary_industry": {
        "include": ["Truck Transportation"],
        "exclude": [],
        "match": "exact"
      },
      "state": {
        "include": ["TX"],
        "exclude": [],
        "match": "exact"
      }
    },
    "job_titles": {
      "include": ["VP of operations"],
      "exclude": [],
      "similar": true
    },
    "lookup_type": null,
    "limit": 25
  },
  "unmapped": [],
  "message": "Review the extracted filters before searching. Unmapped words are not applied."
}
POST/leads-database/saved-filters

Save criteria, with an optional schedule

Saves criteria under a name. With a daily or weekly schedule, LeadFuze reruns the search and exports new matches up to max_results.

Request body application/json
namestringrequired

Up to 80 characters.

criteriaCriteriarequired

Who to find. Fields are combined with AND; values inside one include list with OR; any exclude removes a person.

Show 5 child attributes
querystring

Free text across name, job title, company name, industry, city and state. A complete email, phone, domain or LinkedIn URL runs an exact lookup.

max length 500, default ""
lookup_typestring or null

Force an exact lookup of query. email checks all five email columns; phone all four phone columns; id uses up_id.

emailphonedomainlinkedinid
job_titlesJobTitles
Show 3 child attributes
includestring[]

Whole words or phrases matched inside job_title. Any one is enough.

max items 20
excludestring[]

Remove titles containing any of these. Overrides include.

max items 20
similarboolean

Also match common variants: CEO and Chief Executive Officer, VP of X and Vice President of X, Founder and Co-Founder. At most 20 titles after expansion.

default true
filtersobject

Keyed by catalog field. At most 200 include and exclude values across all filters.

Show filter value shapes

One key per catalog field (see all fields). Fields that start with has_ take an AvailabilityFilter. Every other field takes a FieldCondition.

FieldCondition
includestring[]

Keep people whose value matches any of these.

max items 20
excludestring[]

Remove people whose value matches any of these. A person with no value passes an exclude-only rule.

max items 20
matchstring

exact compares the whole value, ignoring case. phrase finds whole words inside the text and works on job_title, company_name, work_history, education_history, company_description, social_connections. Default phrase for work_history, education_history, company_description, social_connections, exact for the rest.

exactphrase
presencestring

Only people with this field on file, or only people without it.

hasmissing
AvailabilityFilter
valuebooleanrequired
limitinteger

Results per page.

min 1, max 50, default 25
schedulestring

daily, weekly or null.

max_resultsinteger

Rows per scheduled export, 1 to 100,000.

Responses
201Created
idstring (uuid)
namestring
criteriaCriteria

Who to find. Fields are combined with AND; values inside one include list with OR; any exclude removes a person.

Show 5 child attributes
querystring

Free text across name, job title, company name, industry, city and state. A complete email, phone, domain or LinkedIn URL runs an exact lookup.

max length 500, default ""
lookup_typestring or null

Force an exact lookup of query. email checks all five email columns; phone all four phone columns; id uses up_id.

emailphonedomainlinkedinid
job_titlesJobTitles
Show 3 child attributes
includestring[]

Whole words or phrases matched inside job_title. Any one is enough.

max items 20
excludestring[]

Remove titles containing any of these. Overrides include.

max items 20
similarboolean

Also match common variants: CEO and Chief Executive Officer, VP of X and Vice President of X, Founder and Co-Founder. At most 20 titles after expansion.

default true
filtersobject

Keyed by catalog field. At most 200 include and exclude values across all filters.

Show filter value shapes

One key per catalog field (see all fields). Fields that start with has_ take an AvailabilityFilter. Every other field takes a FieldCondition.

FieldCondition
includestring[]

Keep people whose value matches any of these.

max items 20
excludestring[]

Remove people whose value matches any of these. A person with no value passes an exclude-only rule.

max items 20
matchstring

exact compares the whole value, ignoring case. phrase finds whole words inside the text and works on job_title, company_name, work_history, education_history, company_description, social_connections. Default phrase for work_history, education_history, company_description, social_connections, exact for the rest.

exactphrase
presencestring

Only people with this field on file, or only people without it.

hasmissing
AvailabilityFilter
valuebooleanrequired
limitinteger

Results per page.

min 1, max 50, default 25
schedulestring or null
next_run_atstring or null
max_resultsinteger or null
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X POST "https://console.leadfuze.com/api/v1/leads-database/saved-filters" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Texas freight operations leaders",
    "criteria": {
      "query": "",
      "job_titles": {
        "include": ["VP of Operations", "Director of Operations"],
        "exclude": ["Assistant"],
        "similar": true
      },
      "filters": {
        "primary_industry": {
          "include": ["Truck Transportation", "Warehousing And Storage"]
        },
        "company_employee_count": {
          "include": ["101 to 250", "251 to 500"]
        },
        "state": {
          "include": ["Texas", "OK"]
        },
        "company_description": {
          "include": ["cold chain"],
          "match": "phrase"
        },
        "company_domain": {
          "exclude": ["competitor.com"]
        },
        "mobile_phone": {
          "presence": "has"
        },
        "has_business_email": {
          "value": true
        }
      },
      "limit": 25
    },
    "schedule": "weekly",
    "max_results": 500
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/saved-filters', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "name": "Texas freight operations leaders",
    "criteria": {
      "query": "",
      "job_titles": {
        "include": ["VP of Operations", "Director of Operations"],
        "exclude": ["Assistant"],
        "similar": true
      },
      "filters": {
        "primary_industry": {
          "include": ["Truck Transportation", "Warehousing And Storage"]
        },
        "company_employee_count": {
          "include": ["101 to 250", "251 to 500"]
        },
        "state": {
          "include": ["Texas", "OK"]
        },
        "company_description": {
          "include": ["cold chain"],
          "match": "phrase"
        },
        "company_domain": {
          "exclude": ["competitor.com"]
        },
        "mobile_phone": {
          "presence": "has"
        },
        "has_business_email": {
          "value": true
        }
      },
      "limit": 25
    },
    "schedule": "weekly",
    "max_results": 500
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/leads-database/saved-filters",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "name": "Texas freight operations leaders",
        "criteria": {
            "query": "",
            "job_titles": {
                "include": ["VP of Operations", "Director of Operations"],
                "exclude": ["Assistant"],
                "similar": True
            },
            "filters": {
                "primary_industry": {
                    "include": ["Truck Transportation", "Warehousing And Storage"]
                },
                "company_employee_count": {
                    "include": ["101 to 250", "251 to 500"]
                },
                "state": {
                    "include": ["Texas", "OK"]
                },
                "company_description": {
                    "include": ["cold chain"],
                    "match": "phrase"
                },
                "company_domain": {
                    "exclude": ["competitor.com"]
                },
                "mobile_phone": {
                    "presence": "has"
                },
                "has_business_email": {
                    "value": True
                }
            },
            "limit": 25
        },
        "schedule": "weekly",
        "max_results": 500
    },
)
print(r.json())
Response201application/json
{
  "id": "e5a1c7b3-2d9f-4e60-8b14-7a3c0f9d2e58",
  "name": "Texas freight operations leaders",
  "criteria": {
    "query": "",
    "filters": {
      "company_description": {
        "include": ["cold chain"],
        "exclude": [],
        "match": "phrase"
      },
      "company_domain": {
        "include": [],
        "exclude": ["competitor.com"],
        "match": "exact"
      },
      "company_employee_count": {
        "include": ["101 to 250", "251 to 500"],
        "exclude": [],
        "match": "exact"
      },
      "has_business_email": {
        "value": true
      },
      "mobile_phone": {
        "include": [],
        "exclude": [],
        "match": "exact",
        "presence": "has"
      },
      "primary_industry": {
        "include": ["Truck Transportation", "Warehousing And Storage"],
        "exclude": [],
        "match": "exact"
      },
      "state": {
        "include": ["TX", "OK"],
        "exclude": [],
        "match": "exact"
      }
    },
    "job_titles": {
      "include": ["VP of Operations", "Director of Operations"],
      "exclude": ["Assistant"],
      "similar": true
    },
    "lookup_type": null,
    "limit": 25
  },
  "schedule": "weekly",
  "next_run_at": "2026-11-02T14:00:00Z",
  "max_results": 500
}
GET/leads-database/saved-filters

List saved filters

Up to 200, newest first, with schedule, next and last run, and last export id.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X GET "https://console.leadfuze.com/api/v1/leads-database/saved-filters" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/saved-filters', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/leads-database/saved-filters",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "data": []
}
PATCH/leads-database/saved-filters/{saved}

Update a saved filter

Same body as creating one.

Path parameters
savedstring (uuid)required

Saved filter id.

Request body application/json
namestringrequired
max length 80
criteriaCriteriarequired

Who to find. Fields are combined with AND; values inside one include list with OR; any exclude removes a person.

Show 5 child attributes
querystring

Free text across name, job title, company name, industry, city and state. A complete email, phone, domain or LinkedIn URL runs an exact lookup.

max length 500, default ""
lookup_typestring or null

Force an exact lookup of query. email checks all five email columns; phone all four phone columns; id uses up_id.

emailphonedomainlinkedinid
job_titlesJobTitles
Show 3 child attributes
includestring[]

Whole words or phrases matched inside job_title. Any one is enough.

max items 20
excludestring[]

Remove titles containing any of these. Overrides include.

max items 20
similarboolean

Also match common variants: CEO and Chief Executive Officer, VP of X and Vice President of X, Founder and Co-Founder. At most 20 titles after expansion.

default true
filtersobject

Keyed by catalog field. At most 200 include and exclude values across all filters.

Show filter value shapes

One key per catalog field (see all fields). Fields that start with has_ take an AvailabilityFilter. Every other field takes a FieldCondition.

FieldCondition
includestring[]

Keep people whose value matches any of these.

max items 20
excludestring[]

Remove people whose value matches any of these. A person with no value passes an exclude-only rule.

max items 20
matchstring

exact compares the whole value, ignoring case. phrase finds whole words inside the text and works on job_title, company_name, work_history, education_history, company_description, social_connections. Default phrase for work_history, education_history, company_description, social_connections, exact for the rest.

exactphrase
presencestring

Only people with this field on file, or only people without it.

hasmissing
AvailabilityFilter
valuebooleanrequired
limitinteger

Results per page.

min 1, max 50, default 25
schedulestring or null
dailyweekly
max_resultsinteger
min 1, max 100,000
Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X PATCH "https://console.leadfuze.com/api/v1/leads-database/saved-filters/e5a1c7b3-2d9f-4e60-8b14-7a3c0f9d2e58" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "criteria": {
      "query": "",
      "job_titles": {
        "include": ["VP of Operations", "Director of Operations"],
        "exclude": ["Assistant"],
        "similar": true
      },
      "filters": {
        "primary_industry": {
          "include": ["Truck Transportation", "Warehousing And Storage"]
        },
        "company_employee_count": {
          "include": ["101 to 250", "251 to 500"]
        },
        "state": {
          "include": ["Texas", "OK"]
        },
        "company_description": {
          "include": ["cold chain"],
          "match": "phrase"
        },
        "company_domain": {
          "exclude": ["competitor.com"]
        },
        "mobile_phone": {
          "presence": "has"
        },
        "has_business_email": {
          "value": true
        }
      },
      "limit": 25
    },
    "schedule": "daily",
    "max_results": 0
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/saved-filters/e5a1c7b3-2d9f-4e60-8b14-7a3c0f9d2e58', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "name": "string",
    "criteria": {
      "query": "",
      "job_titles": {
        "include": ["VP of Operations", "Director of Operations"],
        "exclude": ["Assistant"],
        "similar": true
      },
      "filters": {
        "primary_industry": {
          "include": ["Truck Transportation", "Warehousing And Storage"]
        },
        "company_employee_count": {
          "include": ["101 to 250", "251 to 500"]
        },
        "state": {
          "include": ["Texas", "OK"]
        },
        "company_description": {
          "include": ["cold chain"],
          "match": "phrase"
        },
        "company_domain": {
          "exclude": ["competitor.com"]
        },
        "mobile_phone": {
          "presence": "has"
        },
        "has_business_email": {
          "value": true
        }
      },
      "limit": 25
    },
    "schedule": "daily",
    "max_results": 0
  })
});
const data = await res.json();
import os, requests

r = requests.patch(
    "https://console.leadfuze.com/api/v1/leads-database/saved-filters/e5a1c7b3-2d9f-4e60-8b14-7a3c0f9d2e58",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "name": "string",
        "criteria": {
            "query": "",
            "job_titles": {
                "include": ["VP of Operations", "Director of Operations"],
                "exclude": ["Assistant"],
                "similar": True
            },
            "filters": {
                "primary_industry": {
                    "include": ["Truck Transportation", "Warehousing And Storage"]
                },
                "company_employee_count": {
                    "include": ["101 to 250", "251 to 500"]
                },
                "state": {
                    "include": ["Texas", "OK"]
                },
                "company_description": {
                    "include": ["cold chain"],
                    "match": "phrase"
                },
                "company_domain": {
                    "exclude": ["competitor.com"]
                },
                "mobile_phone": {
                    "presence": "has"
                },
                "has_business_email": {
                    "value": True
                }
            },
            "limit": 25
        },
        "schedule": "daily",
        "max_results": 0
    },
)
print(r.json())
Response200application/json
{
  "success": true
}
DELETE/leads-database/saved-filters/{saved}

Delete a saved filter

Path parameters
savedstring (uuid)required

Saved filter id.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X DELETE "https://console.leadfuze.com/api/v1/leads-database/saved-filters/e5a1c7b3-2d9f-4e60-8b14-7a3c0f9d2e58" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/saved-filters/e5a1c7b3-2d9f-4e60-8b14-7a3c0f9d2e58', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.delete(
    "https://console.leadfuze.com/api/v1/leads-database/saved-filters/e5a1c7b3-2d9f-4e60-8b14-7a3c0f9d2e58",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/leads-database/exports/{export}/contacts

Page through exported records as JSON

50 records a page, up to page 2,000.

Path parameters
exportstring (uuid)required

The export id.

Query parameters
pageinteger

Page number, from 1.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41/contacts" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41/contacts', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/leads-database/exports/c2d8f1a0-7e4b-4b19-a3c5-8f0e6d2b9a41/contacts",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "name": "Texas freight operations leaders",
  "data": [],
  "total": 5000,
  "page": 1,
  "next_page": 2
}
Enrichment

Enrichment API

Turn an email, phone number, LinkedIn URL or domain into a full person record with the company attached. One at a time, or a CSV in the background.

Credits

One credit per person returned. No match costs nothing, the same person again within 30 days is free, and an answer served from your cache_ttl is free. Every response ends with your remaining credits.

Response shape

data is a list of people. Company fields sit under company and LinkedIn data under social; turn either off with include_company or include_social. Fields with nothing on file are null.

POST/enrichment/email

Enrich by email

Send a business or personal email and get the full person record, with the company and social objects. One credit per match; no match costs nothing, and the same person again within 30 days is free.

1 credit per match
Request body application/json
emailstringrequired

The email to look up.

include_companyboolean

Include the company object. Default true.

include_socialboolean

Include the social object. Default true.

limitinteger

Most profiles to return, 1 to 1,000. Default 100.

pageinteger

Page, from 1.

cache_ttlinteger

Seconds to cache this answer, 60 to 3,600. Default 600. A cached answer costs nothing.

Responses
200OK
successboolean
cachedboolean
dataProfile[]
metaobject
Show 6 child attributes
inputstring
search_typestring
sourcestring
result_countinteger
limitinteger
timestampstring
creditsCredits
Show 3 child attributes
remaininginteger
free_remaininginteger
paid_remaininginteger
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/enrichment/email" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dana@northlinelogistics.com"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/email', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "email": "dana@northlinelogistics.com"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/enrichment/email",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "email": "dana@northlinelogistics.com"
    },
)
print(r.json())
Response200application/json
{
  "success": true,
  "cached": false,
  "data": [
    {
      "up_id": "up_8c41d2e7a9",
      "first_name": "Dana",
      "last_name": "Whitfield",
      "full_name": "Dana Whitfield",
      "business_email": "dana@northlinelogistics.com",
      "personal_emails": "danawhitfield@gmail.com",
      "additional_personal_emails": "dana.w4@yahoo.com",
      "programmatic_business_emails": "dana.whitfield@northlinelogistics.com",
      "mobile_phone": "15125550148",
      "direct_number": "+15125550190",
      "personal_phone": "+15125550173",
      "linkedin_url": "linkedin.com/in/danawhitfield",
      "personal_address": "1180 Oak Ridge Dr",
      "personal_address_2": null,
      "personal_city": "Round Rock",
      "personal_state": "TX",
      "personal_zip": "78681",
      "personal_zip4": "3342",
      "full_address": "1180 Oak Ridge Dr, Round Rock, TX 78681",
      "gender": "F",
      "age_range": "45-54",
      "income_range": "$150,000 to $199,999",
      "net_worth": "$500,000 to $749,999",
      "married": "Y",
      "children": "Y",
      "homeowner": "Y",
      "dob": null,
      "job_title": "VP of Operations",
      "seniority_level": "Vp",
      "department": "Operations",
      "professional_address": "400 Commerce Way",
      "professional_address_2": "Suite 210",
      "professional_city": "Austin",
      "professional_state": "TX",
      "professional_zip": "78744",
      "professional_zip4": "1207",
      "professional_full_address": "400 Commerce Way, Suite 210, Austin, TX 78744",
      "business_email_validation_status": "Valid (Esp)",
      "business_email_last_seen": "2026-10-12",
      "personal_emails_validation_status": "Valid (Esp)",
      "personal_emails_last_seen": "2026-09-28",
      "last_updated": "2026-10-01",
      "created_at": "2026-10-27T15:04:05.000000Z",
      "updated_at": "2026-10-27T15:04:05.000000Z",
      "company": {
        "name": "Northline Logistics",
        "domain": "northlinelogistics.com",
        "phone": "+15125550100",
        "sic": "4213",
        "address": "400 Commerce Way",
        "city": "Austin",
        "state": "TX",
        "zip": "78744",
        "country": "US",
        "linkedin_url": "linkedin.com/company/northlinelogistics",
        "revenue": "50 Million to 100 Million",
        "employee_count": "251 to 500",
        "primary_industry": "Truck Transportation",
        "description": "Regional freight and warehousing for retailers",
        "naics": "484121",
        "related_domains": "northline.io",
        "last_updated": "2026-10-01"
      },
      "social": {
        "linkedin_url": "linkedin.com/in/danawhitfield",
        "social_connections": "500+"
      }
    }
  ],
  "meta": {
    "input": "dana@northlinelogistics.com",
    "search_type": "email",
    "source": "leadfuze",
    "result_count": 1,
    "limit": 100,
    "timestamp": "2026-10-27T15:04:05.000000Z"
  },
  "credits": {
    "remaining": 24812,
    "free_remaining": 0,
    "paid_remaining": 24812
  }
}
POST/enrichment/phone

Enrich by phone

Send a mobile, direct or personal number in any common format.

1 credit per match
Request body application/json
phonestringrequired

The number. phone_number is accepted too.

include_companyboolean

Include the company object. Default true.

include_socialboolean

Include the social object. Default true.

cache_ttlinteger

Seconds to cache this answer, 60 to 3,600. Default 600. A cached answer costs nothing.

Responses
200OK
successboolean
cachedboolean
dataProfile[]
metaobject
Show 6 child attributes
inputstring
search_typestring
sourcestring
result_countinteger
limitinteger
timestampstring
creditsCredits
Show 3 child attributes
remaininginteger
free_remaininginteger
paid_remaininginteger
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/enrichment/phone" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "(512) 555-0148"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/phone', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "phone": "(512) 555-0148"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/enrichment/phone",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "phone": "(512) 555-0148"
    },
)
print(r.json())
Response200application/json
{
  "success": true,
  "cached": false,
  "data": [
    {
      "up_id": "up_8c41d2e7a9",
      "first_name": "Dana",
      "last_name": "Whitfield",
      "full_name": "Dana Whitfield",
      "business_email": "dana@northlinelogistics.com",
      "personal_emails": "danawhitfield@gmail.com",
      "additional_personal_emails": "dana.w4@yahoo.com",
      "programmatic_business_emails": "dana.whitfield@northlinelogistics.com",
      "mobile_phone": "15125550148",
      "direct_number": "+15125550190",
      "personal_phone": "+15125550173",
      "linkedin_url": "linkedin.com/in/danawhitfield",
      "personal_address": "1180 Oak Ridge Dr",
      "personal_address_2": null,
      "personal_city": "Round Rock",
      "personal_state": "TX",
      "personal_zip": "78681",
      "personal_zip4": "3342",
      "full_address": "1180 Oak Ridge Dr, Round Rock, TX 78681",
      "gender": "F",
      "age_range": "45-54",
      "income_range": "$150,000 to $199,999",
      "net_worth": "$500,000 to $749,999",
      "married": "Y",
      "children": "Y",
      "homeowner": "Y",
      "dob": null,
      "job_title": "VP of Operations",
      "seniority_level": "Vp",
      "department": "Operations",
      "professional_address": "400 Commerce Way",
      "professional_address_2": "Suite 210",
      "professional_city": "Austin",
      "professional_state": "TX",
      "professional_zip": "78744",
      "professional_zip4": "1207",
      "professional_full_address": "400 Commerce Way, Suite 210, Austin, TX 78744",
      "business_email_validation_status": "Valid (Esp)",
      "business_email_last_seen": "2026-10-12",
      "personal_emails_validation_status": "Valid (Esp)",
      "personal_emails_last_seen": "2026-09-28",
      "last_updated": "2026-10-01",
      "created_at": "2026-10-27T15:04:05.000000Z",
      "updated_at": "2026-10-27T15:04:05.000000Z",
      "company": {
        "name": "Northline Logistics",
        "domain": "northlinelogistics.com",
        "phone": "+15125550100",
        "sic": "4213",
        "address": "400 Commerce Way",
        "city": "Austin",
        "state": "TX",
        "zip": "78744",
        "country": "US",
        "linkedin_url": "linkedin.com/company/northlinelogistics",
        "revenue": "50 Million to 100 Million",
        "employee_count": "251 to 500",
        "primary_industry": "Truck Transportation",
        "description": "Regional freight and warehousing for retailers",
        "naics": "484121",
        "related_domains": "northline.io",
        "last_updated": "2026-10-01"
      },
      "social": {
        "linkedin_url": "linkedin.com/in/danawhitfield",
        "social_connections": "500+"
      }
    }
  ],
  "meta": {
    "input": "15125550148",
    "search_type": "phone",
    "source": "leadfuze",
    "result_count": 1,
    "limit": 100,
    "timestamp": "2026-10-27T15:04:05.000000Z"
  },
  "credits": {
    "remaining": 24812,
    "free_remaining": 0,
    "paid_remaining": 24812
  }
}
POST/enrichment/linkedin

Enrich by LinkedIn URL

Send a LinkedIn profile URL. The www and https parts are optional.

1 credit per match
Request body application/json
linkedin_urlstringrequired

The profile URL. linkedin is accepted too.

include_companyboolean

Include the company object. Default true.

include_socialboolean

Include the social object. Default true.

cache_ttlinteger

Seconds to cache this answer, 60 to 3,600. Default 600. A cached answer costs nothing.

Responses
200OK
successboolean
cachedboolean
dataProfile[]
metaobject
Show 6 child attributes
inputstring
search_typestring
sourcestring
result_countinteger
limitinteger
timestampstring
creditsCredits
Show 3 child attributes
remaininginteger
free_remaininginteger
paid_remaininginteger
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/enrichment/linkedin" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "linkedin_url": "linkedin.com/in/danawhitfield"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/linkedin', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "linkedin_url": "linkedin.com/in/danawhitfield"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/enrichment/linkedin",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "linkedin_url": "linkedin.com/in/danawhitfield"
    },
)
print(r.json())
Response200application/json
{
  "success": true,
  "cached": false,
  "data": [
    {
      "up_id": "up_8c41d2e7a9",
      "first_name": "Dana",
      "last_name": "Whitfield",
      "full_name": "Dana Whitfield",
      "business_email": "dana@northlinelogistics.com",
      "personal_emails": "danawhitfield@gmail.com",
      "additional_personal_emails": "dana.w4@yahoo.com",
      "programmatic_business_emails": "dana.whitfield@northlinelogistics.com",
      "mobile_phone": "15125550148",
      "direct_number": "+15125550190",
      "personal_phone": "+15125550173",
      "linkedin_url": "linkedin.com/in/danawhitfield",
      "personal_address": "1180 Oak Ridge Dr",
      "personal_address_2": null,
      "personal_city": "Round Rock",
      "personal_state": "TX",
      "personal_zip": "78681",
      "personal_zip4": "3342",
      "full_address": "1180 Oak Ridge Dr, Round Rock, TX 78681",
      "gender": "F",
      "age_range": "45-54",
      "income_range": "$150,000 to $199,999",
      "net_worth": "$500,000 to $749,999",
      "married": "Y",
      "children": "Y",
      "homeowner": "Y",
      "dob": null,
      "job_title": "VP of Operations",
      "seniority_level": "Vp",
      "department": "Operations",
      "professional_address": "400 Commerce Way",
      "professional_address_2": "Suite 210",
      "professional_city": "Austin",
      "professional_state": "TX",
      "professional_zip": "78744",
      "professional_zip4": "1207",
      "professional_full_address": "400 Commerce Way, Suite 210, Austin, TX 78744",
      "business_email_validation_status": "Valid (Esp)",
      "business_email_last_seen": "2026-10-12",
      "personal_emails_validation_status": "Valid (Esp)",
      "personal_emails_last_seen": "2026-09-28",
      "last_updated": "2026-10-01",
      "created_at": "2026-10-27T15:04:05.000000Z",
      "updated_at": "2026-10-27T15:04:05.000000Z",
      "company": {
        "name": "Northline Logistics",
        "domain": "northlinelogistics.com",
        "phone": "+15125550100",
        "sic": "4213",
        "address": "400 Commerce Way",
        "city": "Austin",
        "state": "TX",
        "zip": "78744",
        "country": "US",
        "linkedin_url": "linkedin.com/company/northlinelogistics",
        "revenue": "50 Million to 100 Million",
        "employee_count": "251 to 500",
        "primary_industry": "Truck Transportation",
        "description": "Regional freight and warehousing for retailers",
        "naics": "484121",
        "related_domains": "northline.io",
        "last_updated": "2026-10-01"
      },
      "social": {
        "linkedin_url": "linkedin.com/in/danawhitfield",
        "social_connections": "500+"
      }
    }
  ],
  "meta": {
    "input": "linkedin.com/in/danawhitfield",
    "search_type": "linkedin",
    "source": "leadfuze",
    "result_count": 1,
    "limit": 100,
    "timestamp": "2026-10-27T15:04:05.000000Z"
  },
  "credits": {
    "remaining": 24812,
    "free_remaining": 0,
    "paid_remaining": 24812
  }
}
POST/enrichment/domain

Find people at a company domain

Send a domain and get the people who work there, a page at a time.

1 credit per profile returned
Request body application/json
domainstringrequired

A company domain, for example northlinelogistics.com.

include_companyboolean

Include the company object. Default true.

include_socialboolean

Include the social object. Default true.

limitinteger

Profiles per page, 1 to 1,000. Default 100.

pageinteger

Page, from 1.

cache_ttlinteger

Seconds to cache this answer, 60 to 3,600. Default 600. A cached answer costs nothing.

Responses
200OK
successboolean
cachedboolean
dataProfile[]
metaobject
Show 6 child attributes
inputstring
search_typestring
sourcestring
result_countinteger
limitinteger
timestampstring
creditsCredits
Show 3 child attributes
remaininginteger
free_remaininginteger
paid_remaininginteger
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/enrichment/domain" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "northlinelogistics.com",
    "limit": 25
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/domain', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "domain": "northlinelogistics.com",
    "limit": 25
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/enrichment/domain",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "domain": "northlinelogistics.com",
        "limit": 25
    },
)
print(r.json())
Response200application/json
{
  "success": true,
  "cached": false,
  "data": [
    {
      "up_id": "up_8c41d2e7a9",
      "first_name": "Dana",
      "last_name": "Whitfield",
      "full_name": "Dana Whitfield",
      "business_email": "dana@northlinelogistics.com",
      "personal_emails": "danawhitfield@gmail.com",
      "additional_personal_emails": "dana.w4@yahoo.com",
      "programmatic_business_emails": "dana.whitfield@northlinelogistics.com",
      "mobile_phone": "15125550148",
      "direct_number": "+15125550190",
      "personal_phone": "+15125550173",
      "linkedin_url": "linkedin.com/in/danawhitfield",
      "personal_address": "1180 Oak Ridge Dr",
      "personal_address_2": null,
      "personal_city": "Round Rock",
      "personal_state": "TX",
      "personal_zip": "78681",
      "personal_zip4": "3342",
      "full_address": "1180 Oak Ridge Dr, Round Rock, TX 78681",
      "gender": "F",
      "age_range": "45-54",
      "income_range": "$150,000 to $199,999",
      "net_worth": "$500,000 to $749,999",
      "married": "Y",
      "children": "Y",
      "homeowner": "Y",
      "dob": null,
      "job_title": "VP of Operations",
      "seniority_level": "Vp",
      "department": "Operations",
      "professional_address": "400 Commerce Way",
      "professional_address_2": "Suite 210",
      "professional_city": "Austin",
      "professional_state": "TX",
      "professional_zip": "78744",
      "professional_zip4": "1207",
      "professional_full_address": "400 Commerce Way, Suite 210, Austin, TX 78744",
      "business_email_validation_status": "Valid (Esp)",
      "business_email_last_seen": "2026-10-12",
      "personal_emails_validation_status": "Valid (Esp)",
      "personal_emails_last_seen": "2026-09-28",
      "last_updated": "2026-10-01",
      "created_at": "2026-10-27T15:04:05.000000Z",
      "updated_at": "2026-10-27T15:04:05.000000Z",
      "company": {
        "name": "Northline Logistics",
        "domain": "northlinelogistics.com",
        "phone": "+15125550100",
        "sic": "4213",
        "address": "400 Commerce Way",
        "city": "Austin",
        "state": "TX",
        "zip": "78744",
        "country": "US",
        "linkedin_url": "linkedin.com/company/northlinelogistics",
        "revenue": "50 Million to 100 Million",
        "employee_count": "251 to 500",
        "primary_industry": "Truck Transportation",
        "description": "Regional freight and warehousing for retailers",
        "naics": "484121",
        "related_domains": "northline.io",
        "last_updated": "2026-10-01"
      },
      "social": {
        "linkedin_url": "linkedin.com/in/danawhitfield",
        "social_connections": "500+"
      }
    }
  ],
  "meta": {
    "input": "northlinelogistics.com",
    "search_type": "domain",
    "source": "leadfuze",
    "result_count": 1,
    "limit": 100,
    "timestamp": "2026-10-27T15:04:05.000000Z"
  },
  "credits": {
    "remaining": 24812,
    "free_remaining": 0,
    "paid_remaining": 24812
  }
}
POST/enrichment/profile

Get a profile by up_id

Fetch a person you already have the up_id for, from a search, a pixel lead or an earlier lookup.

1 credit per match
Request body application/json
up_idstringrequired

The profile id.

include_companyboolean

Include the company object. Default true.

include_socialboolean

Include the social object. Default true.

Responses
200OK
successboolean
cachedboolean
dataProfile[]
metaobject
Show 6 child attributes
inputstring
search_typestring
sourcestring
result_countinteger
limitinteger
timestampstring
creditsCredits
Show 3 child attributes
remaininginteger
free_remaininginteger
paid_remaininginteger
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/enrichment/profile" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "up_id": "up_8c41d2e7a9"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/profile', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "up_id": "up_8c41d2e7a9"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/enrichment/profile",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "up_id": "up_8c41d2e7a9"
    },
)
print(r.json())
Response200application/json
{
  "success": true,
  "cached": false,
  "data": [
    {
      "up_id": "up_8c41d2e7a9",
      "first_name": "Dana",
      "last_name": "Whitfield",
      "full_name": "Dana Whitfield",
      "business_email": "dana@northlinelogistics.com",
      "personal_emails": "danawhitfield@gmail.com",
      "additional_personal_emails": "dana.w4@yahoo.com",
      "programmatic_business_emails": "dana.whitfield@northlinelogistics.com",
      "mobile_phone": "15125550148",
      "direct_number": "+15125550190",
      "personal_phone": "+15125550173",
      "linkedin_url": "linkedin.com/in/danawhitfield",
      "personal_address": "1180 Oak Ridge Dr",
      "personal_address_2": null,
      "personal_city": "Round Rock",
      "personal_state": "TX",
      "personal_zip": "78681",
      "personal_zip4": "3342",
      "full_address": "1180 Oak Ridge Dr, Round Rock, TX 78681",
      "gender": "F",
      "age_range": "45-54",
      "income_range": "$150,000 to $199,999",
      "net_worth": "$500,000 to $749,999",
      "married": "Y",
      "children": "Y",
      "homeowner": "Y",
      "dob": null,
      "job_title": "VP of Operations",
      "seniority_level": "Vp",
      "department": "Operations",
      "professional_address": "400 Commerce Way",
      "professional_address_2": "Suite 210",
      "professional_city": "Austin",
      "professional_state": "TX",
      "professional_zip": "78744",
      "professional_zip4": "1207",
      "professional_full_address": "400 Commerce Way, Suite 210, Austin, TX 78744",
      "business_email_validation_status": "Valid (Esp)",
      "business_email_last_seen": "2026-10-12",
      "personal_emails_validation_status": "Valid (Esp)",
      "personal_emails_last_seen": "2026-09-28",
      "last_updated": "2026-10-01",
      "created_at": "2026-10-27T15:04:05.000000Z",
      "updated_at": "2026-10-27T15:04:05.000000Z",
      "company": {
        "name": "Northline Logistics",
        "domain": "northlinelogistics.com",
        "phone": "+15125550100",
        "sic": "4213",
        "address": "400 Commerce Way",
        "city": "Austin",
        "state": "TX",
        "zip": "78744",
        "country": "US",
        "linkedin_url": "linkedin.com/company/northlinelogistics",
        "revenue": "50 Million to 100 Million",
        "employee_count": "251 to 500",
        "primary_industry": "Truck Transportation",
        "description": "Regional freight and warehousing for retailers",
        "naics": "484121",
        "related_domains": "northline.io",
        "last_updated": "2026-10-01"
      },
      "social": {
        "linkedin_url": "linkedin.com/in/danawhitfield",
        "social_connections": "500+"
      }
    }
  ],
  "meta": {
    "input": "up_8c41d2e7a9",
    "search_type": "profile",
    "source": "leadfuze",
    "result_count": 1,
    "limit": 100,
    "timestamp": "2026-10-27T15:04:05.000000Z"
  },
  "credits": {
    "remaining": 24812,
    "free_remaining": 0,
    "paid_remaining": 24812
  }
}
POST/enrichment/email/bulk-csv

Enrich a CSV of emails

Upload a file of emails. The job runs in the background and answers 202 with links to poll and download.

1 credit per match
Request body multipart/form-data
filestring (binary)required

A CSV or TXT file up to 50MB with one value per row. A header row is optional.

Responses
202Accepted
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/enrichment/email/bulk-csv" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -F "file=@contacts.csv"
const form = new FormData();
form.append('file', fileInput.files[0]);

const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/email/bulk-csv', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}` },
  body: form
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/enrichment/email/bulk-csv",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    files={"file": open("contacts.csv", "rb")},
)
print(r.json())
Response202application/json
{
  "success": true,
  "message": "Bulk enrichment job started",
  "bulk_job_id": "b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03",
  "total_entries": 12000,
  "status_url": "https://console.leadfuze.com/api/v1/enrichment/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status",
  "download_url": "https://console.leadfuze.com/api/v1/enrichment/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download",
  "processing_mode": "async",
  "note": "Job is processing in background. Poll status_url to track progress."
}
GET/enrichment/bulk/{bulkJobId}/status

Check a bulk job

Progress and counts for a bulk enrichment job.

Path parameters
bulkJobIdstring (uuid)required

The bulk_job_id returned when the job was created.

Responses
200OK
successboolean
dataobject
Show 16 child attributes
bulk_job_idstring
filenamestring
entry_typestring
statusstring
total_entriesinteger
processed_entriesinteger
progress_percentagenumber
success_countinteger
not_found_countinteger
invalid_countinteger
skipped_countinteger
credits_usedinteger
error_messagestring or null
started_atstring or null
completed_atstring or null
created_atstring
download_urlstring
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/enrichment/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/enrichment/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true,
  "data": {
    "bulk_job_id": "b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03",
    "filename": "webinar-signups.csv",
    "entry_type": "email",
    "status": "processing",
    "total_entries": 12000,
    "processed_entries": 7400,
    "progress_percentage": 61.67,
    "success_count": 5310,
    "not_found_count": 1980,
    "invalid_count": 64,
    "skipped_count": 46,
    "credits_used": 5310,
    "error_message": null,
    "started_at": "2026-10-27T15:04:05.000000Z",
    "completed_at": null,
    "created_at": "2026-10-27T15:04:05.000000Z"
  },
  "download_url": "https://console.leadfuze.com/api/v1/enrichment/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download"
}
POST/enrichment/linkedin/bulk-csv

Enrich a CSV of LinkedIn URLs

Same as the email version, one URL per row.

Request body multipart/form-data
filestring (binary)required

A CSV or TXT file up to 50MB with one value per row. A header row is optional.

Responses
202Accepted
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X POST "https://console.leadfuze.com/api/v1/enrichment/linkedin/bulk-csv" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -F "file=@contacts.csv"
const form = new FormData();
form.append('file', fileInput.files[0]);

const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/linkedin/bulk-csv', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}` },
  body: form
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/enrichment/linkedin/bulk-csv",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    files={"file": open("contacts.csv", "rb")},
)
print(r.json())
Response202application/json
{
  "success": true
}
GET/enrichment/bulk/{bulkJobId}/download

Download bulk results

A CSV of every input row with the matched fields.

Path parameters
bulkJobIdstring (uuid)required

The bulk_job_id returned when the job was created.

Responses
200The file.
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/enrichment/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.text();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/enrichment/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.text)
Response200text/csv
up_id,cc_id,first_name,last_name,job_title,company_name,business_email,mobile_phone,...
up_8c41d2e7a9,cc_51b9e0a4f2,Dana,Whitfield,VP of Operations,Northline Logistics,dana@northlinelogistics.com,15125550148,...
POST/enrichment/companies/search

Search companies

Find companies by domain, name, industry, size or a role they employ. 25 a page by default; pass the search_id or next_cursor back for more.

Request body application/json
domainstring

Company domain.

company_namestring

At least 3 characters.

industrystring

An industry from the catalog.

rolestring

A job title the company employs.

company_sizestring

An employee count range, for example 251 to 500.

limitinteger

1 to 100.

pageinteger

Page, from 1.

search_idstring (uuid)

Continue an earlier search.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X POST "https://console.leadfuze.com/api/v1/enrichment/companies/search" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/companies/search', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/enrichment/companies/search",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={},
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/enrichment/company

Company lookup by domain or cc_id

Returns a summary of a company and the people on file there, with filter counts, ready to page through.

Request body application/json
domainstring

Company domain. Send this or cc_id.

cc_idstring

Company id.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X POST "https://console.leadfuze.com/api/v1/enrichment/company" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
const res = await fetch('https://console.leadfuze.com/api/v1/enrichment/company', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/enrichment/company",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={},
)
print(r.json())
Response200application/json
{
  "success": true
}
Email verification

Email verification API

Check whether an address will accept mail before you send to it, one at a time, 100 at once or a whole file.

Statuses

valid is safe to send. risky means the domain accepts every address (catch-all) or the inbox is full. invalid will bounce. unknown means the mail server did not answer.

POST/verification/email

Verify an email

Checks syntax, the mail server and the mailbox, and whether the domain accepts every address (catch-all). Status is valid, risky, invalid or unknown, with a risk level of low, medium or high.

1 verification credit
Request body application/json
emailstringrequired

The address to check.

cache_ttlinteger

Seconds to cache this answer, 60 to 3,600. Default 600. A cached answer costs nothing.

Responses
200OK
successboolean
cachedboolean
dataobject
Show 7 child attributes
emailstring
usernamestring
domainstring
md5_hashstring
resultobject
Show 5 child attributes
valid_formatboolean
deliverableboolean
full_inboxboolean
host_existsboolean
catch_allboolean
statusstring
validriskyinvalidunknown
risk_levelstring
lowmediumhigh
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/verification/email" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dana@northlinelogistics.com"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/verification/email', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "email": "dana@northlinelogistics.com"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/verification/email",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "email": "dana@northlinelogistics.com"
    },
)
print(r.json())
Response200application/json
{
  "success": true,
  "cached": false,
  "data": {
    "email": "dana@northlinelogistics.com",
    "username": "dana",
    "domain": "northlinelogistics.com",
    "md5_hash": "5d1f8c0a9e2b7d4f6a3c1e0b9d8f7a6c",
    "result": {
      "valid_format": true,
      "deliverable": true,
      "full_inbox": false,
      "host_exists": true,
      "catch_all": false
    },
    "status": "valid",
    "risk_level": "low"
  },
  "meta": {
    "input": "dana@northlinelogistics.com",
    "source": "validator",
    "timestamp": "2026-10-27T15:04:05.000000Z",
    "response_time_ms": 412
  },
  "credits": {
    "used": 1,
    "remaining": 9431
  }
}
POST/verification/bulk

Verify up to 100 emails

The same checks for a list, answered in one response.

1 verification credit per address
Request body application/json
emailsstring[]required

1 to 100 addresses.

cache_ttlinteger

Seconds to cache this answer, 60 to 3,600. Default 600. A cached answer costs nothing.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/verification/bulk" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": ["dana@northlinelogistics.com", "ops@northlinelogistics.com"]
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/verification/bulk', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "emails": ["dana@northlinelogistics.com", "ops@northlinelogistics.com"]
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/verification/bulk",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "emails": ["dana@northlinelogistics.com", "ops@northlinelogistics.com"]
    },
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/verification/bulk-csv

Verify a CSV of emails

Upload up to about a million addresses. Large files run in the background; poll the status and download the results.

1 verification credit per address
Request body multipart/form-data
filestring (binary)required

A CSV or TXT file up to 50MB with one value per row. A header row is optional.

asyncboolean

Force background processing for a small file.

Responses
202Accepted
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/verification/bulk-csv" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -F "file=@contacts.csv"
const form = new FormData();
form.append('file', fileInput.files[0]);

const res = await fetch('https://console.leadfuze.com/api/v1/verification/bulk-csv', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}` },
  body: form
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/verification/bulk-csv",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    files={"file": open("contacts.csv", "rb")},
)
print(r.json())
Response202application/json
{
  "success": true,
  "bulk_job_id": "b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03",
  "status_url": "https://console.leadfuze.com/api/v1/verification/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status",
  "download_url": "https://console.leadfuze.com/api/v1/verification/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download"
}
GET/verification/bulk/{bulkJobId}/status

Check a bulk verification

Path parameters
bulkJobIdstring (uuid)required

The bulk_job_id returned when the job was created.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/verification/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/verification/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/verification/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/verification/bulk/{bulkJobId}/download

Download verification results

A CSV with status and risk level per address.

Path parameters
bulkJobIdstring (uuid)required

The bulk_job_id returned when the job was created.

Responses
200The file.
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/verification/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/verification/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.text();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/verification/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.text)
Response200text/csv
up_id,cc_id,first_name,last_name,job_title,company_name,business_email,mobile_phone,...
up_8c41d2e7a9,cc_51b9e0a4f2,Dana,Whitfield,VP of Operations,Northline Logistics,dana@northlinelogistics.com,15125550148,...
GET/verification/credits

Verification credits left

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X GET "https://console.leadfuze.com/api/v1/verification/credits" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/verification/credits', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/verification/credits",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
Phone validation

Phone validation API

Confirm a number is real, see whether it is a mobile, and get it back in E.164 and local formats.

Statuses

valid numbers parse and are valid for their region. risky covers numbers that are only possible, premium rate or otherwise unusual. invalid numbers cannot be dialed.

POST/phone-validation/validate

Validate a phone number

Parses the number, formats it as E.164, international and national, and tells you the line type, carrier and time zones. Status is valid, risky or invalid.

1 phone credit
Request body application/json
phone_numberstringrequired

The number in any common format.

regionstring

Two-letter country to assume when the number has no country code. Default US.

cache_ttlinteger

Seconds to cache this answer, 60 to 3,600. Default 600. A cached answer costs nothing.

Responses
200OK
successboolean
cachedboolean
dataobject
Show 7 child attributes
phone_numberstring
formattedobject
Show 3 child attributes
e164string
internationalstring
nationalstring
resultobject
Show 7 child attributes
is_validboolean
is_possibleboolean
number_typestring
Fixed LineMobileFixed Line or MobileToll FreePremium RateShared CostVoIPPersonal NumberPagerUANVoicemailUnknown
regionstring
is_valid_for_regionboolean
country_codeinteger
national_numberstring
statusstring
validriskyinvalid
risk_levelstring
lowmediumhigh
carrierstring or null
timezonesstring[]
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/phone-validation/validate" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "(512) 555-0148",
    "region": "US"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/phone-validation/validate', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "phone_number": "(512) 555-0148",
    "region": "US"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/phone-validation/validate",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "phone_number": "(512) 555-0148",
        "region": "US"
    },
)
print(r.json())
Response200application/json
{
  "success": true,
  "cached": false,
  "data": {
    "phone_number": "(512) 555-0148",
    "phone_hash": "9f2c7a1e0b8d6f4a",
    "formatted": {
      "e164": "+15125550148",
      "international": "+1 512-555-0148",
      "national": "(512) 555-0148"
    },
    "result": {
      "is_valid": true,
      "is_possible": true,
      "number_type": "Mobile",
      "number_type_code": 1,
      "region": "US",
      "is_valid_for_region": true,
      "country_code": 1,
      "national_number": "5125550148"
    },
    "status": "valid",
    "risk_level": "low",
    "carrier": "Example Wireless",
    "timezones": ["America/Chicago"]
  },
  "meta": {
    "input": "(512) 555-0148",
    "default_region": "US",
    "source": "libphonenumber",
    "timestamp": "2026-10-27T15:04:05.000000Z",
    "response_time_ms": 6
  }
}
POST/phone-validation/bulk

Validate up to 100 numbers

Request body application/json
phone_numbersstring[]required

1 to 100 numbers.

regionstring

Default country.

cache_ttlinteger

Seconds to cache this answer, 60 to 3,600. Default 600. A cached answer costs nothing.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/phone-validation/bulk" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_numbers": ["(512) 555-0148", "+1 512 555 0190"],
    "region": "US"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/phone-validation/bulk', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "phone_numbers": ["(512) 555-0148", "+1 512 555 0190"],
    "region": "US"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/phone-validation/bulk",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "phone_numbers": ["(512) 555-0148", "+1 512 555 0190"],
        "region": "US"
    },
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/phone-validation/bulk-csv

Validate a CSV of numbers

Runs in the background for large files.

Request body multipart/form-data
filestring (binary)required

A CSV or TXT file up to 50MB with one value per row. A header row is optional.

regionstring

Default country.

asyncboolean

Force background processing.

Responses
202Accepted
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X POST "https://console.leadfuze.com/api/v1/phone-validation/bulk-csv" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -F "file=@contacts.csv"
const form = new FormData();
form.append('file', fileInput.files[0]);

const res = await fetch('https://console.leadfuze.com/api/v1/phone-validation/bulk-csv', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}` },
  body: form
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/phone-validation/bulk-csv",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    files={"file": open("contacts.csv", "rb")},
)
print(r.json())
Response202application/json
{
  "success": true
}
GET/phone-validation/bulk/{bulkJobId}/status

Check a bulk validation

Path parameters
bulkJobIdstring (uuid)required

The bulk_job_id returned when the job was created.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/phone-validation/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/phone-validation/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/phone-validation/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/status",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/phone-validation/bulk/{bulkJobId}/download

Download validation results

Path parameters
bulkJobIdstring (uuid)required

The bulk_job_id returned when the job was created.

Responses
200The file.
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/phone-validation/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/phone-validation/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.text();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/phone-validation/bulk/b7e2a9c4-1f3d-4a8b-9c60-5e2d8f1a7b03/download",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.text)
Response200text/csv
up_id,cc_id,first_name,last_name,job_title,company_name,business_email,mobile_phone,...
up_8c41d2e7a9,cc_51b9e0a4f2,Dana,Whitfield,VP of Operations,Northline Logistics,dana@northlinelogistics.com,15125550148,...
GET/phone-validation/credits

Phone credits left

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X GET "https://console.leadfuze.com/api/v1/phone-validation/credits" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/phone-validation/credits', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/phone-validation/credits",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
Intent data

Intent data API

Find the people researching a topic across the internet. Search 42,000+ topics, run a scan, and download the people as a file.

How a scan works

  1. Find a topic with GET /intent-data/search.
  2. Run a scan with POST /intent-data. Each topic uses one Intent Scan from your plan.
  3. Poll GET /intent-data/{id}/status until it is done, then download the files in data_urls.
GET/intent-data/search

Find intent topics

Search 42,000+ B2B and B2C topics by name. Topics already being scanned for you are left out.

Query parameters
qstringrequired

2 to 255 characters.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X GET "https://console.leadfuze.com/api/v1/intent-data/search?q=warehouse%20management" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/intent-data/search?q=warehouse%20management', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/intent-data/search?q=warehouse%20management",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true,
  "data": [
    {
      "id": 18734,
      "topic_id": "18734",
      "topic": "Warehouse Management Systems",
      "category_type": "b2b"
    }
  ],
  "meta": {
    "query": "warehouse management",
    "result_count": 1,
    "timestamp": "2026-10-27T15:04:05.000000Z"
  }
}
POST/intent-data

Run an Intent Scan

Request the people researching one or more topics. Each topic uses one Intent Scan from your plan; duplicates of a scan already running are skipped.

1 Intent Scan per topic
Request body application/json
categoriesobject[]required

Topics to scan.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
402Out of credits for this product.
Request
curl -X POST "https://console.leadfuze.com/api/v1/intent-data" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "categories": [
      {
        "topic_id": "18734",
        "topic": "Warehouse Management Systems",
        "category_type": "b2b"
      }
    ]
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/intent-data', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "categories": [
      {
        "topic_id": "18734",
        "topic": "Warehouse Management Systems",
        "category_type": "b2b"
      }
    ]
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/intent-data",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "categories": [
            {
                "topic_id": "18734",
                "topic": "Warehouse Management Systems",
                "category_type": "b2b"
            }
        ]
    },
)
print(r.json())
Response200application/json
{
  "success": true,
  "message": "1 intent data request(s) created.",
  "data": [
    {
      "id": 5521,
      "topic_id": "18734",
      "category_type": "b2b",
      "topic": "Warehouse Management Systems",
      "status": "pending",
      "created_at": "2026-10-27T15:04:05.000000Z"
    }
  ],
  "meta": {
    "created_count": 1,
    "duplicate_count": 0,
    "credits_remaining": 9,
    "credits_used_this_month": 1,
    "timestamp": "2026-10-27T15:04:05.000000Z"
  }
}
GET/intent-data

List your scans

Paginated, newest first.

Query parameters
statusstring

pending, done or failed.

per_pageinteger

Default 20.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X GET "https://console.leadfuze.com/api/v1/intent-data" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/intent-data', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/intent-data",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/intent-data/{id}/status

Check a scan

Status is pending, done or failed. When done, data_urls holds the files to download.

Path parameters
idintegerrequired

The request id.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/intent-data/5521/status" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/intent-data/5521/status', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/intent-data/5521/status",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true,
  "data": {
    "id": 5521,
    "topic_id": "18734",
    "category_type": "b2b",
    "topic": "Warehouse Management Systems",
    "status": "done",
    "data_urls": [
      {
        "id": 90211,
        "file_url": "https://files.leadfuze.com/intent/5521/people.zip",
        "label": "people.zip"
      }
    ],
    "created_at": "2026-10-27T15:04:05.000000Z",
    "updated_at": "2026-10-27T15:04:05.000000Z"
  },
  "meta": {
    "timestamp": "2026-10-27T15:04:05.000000Z"
  }
}
GET/intent-data/{id}

Get a scan

Path parameters
idintegerrequired

The request id.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/intent-data/5521" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/intent-data/5521', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/intent-data/5521",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/intent-data/{id}/retry

Retry a failed scan

Runs it again without using another Intent Scan.

Path parameters
idintegerrequired

The request id.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/intent-data/5521/retry" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/intent-data/5521/retry', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/intent-data/5521/retry",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
Identity Resolution Pixel

Identity Resolution Pixel API

Create a pixel project per website, place its tracking code, and receive every identified visitor by API, webhook or a connected tool.

Install

Create a project for each website and place its tracking_code in the head of every page. Resellers can rename the script variable and path with tracking_variable and tracking_slug.

Webhook events

Each new or updated lead is posted to your URL as lead.created or lead.updated, with an X-Event-Type header. When the project has a webhook secret, X-Webhook-Signature carries an HMAC-SHA256 of the raw body, so you can confirm it came from LeadFuze.

Webhook eventPOST to your URL
{
  "event": "lead.created",
  "timestamp": "2026-10-27T15:04:05+00:00",
  "project_id": 812,
  "lead": {
    "id": 440193,
    "email": "dana@northlinelogistics.com",
    "ip": "203.0.113.24",
    "first_name": "Dana",
    "last_name": "Whitfield",
    "business_email": "dana@northlinelogistics.com",
    "personal_email": "danawhitfield@gmail.com",
    "mobile_phone": "15125550148",
    "personal_phone": "+15125550173",
    "direct_number": "+15125550190",
    "job_title": "VP of Operations",
    "department": "Operations",
    "personal_address": "1180 Oak Ridge Dr",
    "personal_city": "Round Rock",
    "personal_state": "TX",
    "personal_zip": "78681",
    "professional_address": "400 Commerce Way",
    "professional_city": "Austin",
    "professional_state": "TX",
    "professional_zip": "78744",
    "gender": "F",
    "age_range": "45-54",
    "marital_status": "Married",
    "children": "Y",
    "income_range": "$150,000 to $199,999",
    "net_worth": "$500,000 to $749,999",
    "created_at": "2026-10-27T15:04:01+00:00",
    "updated_at": "2026-10-27T15:04:01+00:00"
  }
}
POST/projects

Create a pixel project

One project per website. The response includes the tracking code to place on every page of that site.

Request body application/json
namestringrequired

A name you will recognize.

urlstring (url)required

The website the pixel runs on.

statusstring

active, inactive or archived.

user_idinteger

Assign it to one of your users.

Responses
201Created
idinteger
project_identifierstring
namestring
urlstring
statusstring
activeinactivearchived
is_paidboolean
tracking_codestring
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X POST "https://console.leadfuze.com/api/v1/projects" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Northline Logistics website",
    "url": "https://northlinelogistics.com"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/projects', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "name": "Northline Logistics website",
    "url": "https://northlinelogistics.com"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/projects",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "name": "Northline Logistics website",
        "url": "https://northlinelogistics.com"
    },
)
print(r.json())
Response201application/json
{
  "id": 812,
  "project_identifier": "leq4k7m2x",
  "name": "Northline Logistics website",
  "url": "https://northlinelogistics.com",
  "status": "active",
  "is_paid": true,
  "tracking_code": "<script async type=\"text/javascript\">(function(){window.__idrp=window.__idrp||{};window.__idrp.appId=\"leq4k7m2x\";var leadfuze=window.leadfuze||(window.leadfuze=[]);if(leadfuze.invoked)return;leadfuze.invoked=true;...})();</script>"
}
GET/projects

List projects

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X GET "https://console.leadfuze.com/api/v1/projects" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/projects', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/projects",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/projects/{identifier}/leads

List identified visitors

Everyone the pixel identified on this site, newest first, with the pages they viewed.

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Query parameters
pageinteger

From 1.

per_pageinteger

1 to 100.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/leads" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x/leads', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/leads",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true,
  "data": [
    {
      "id": 440193,
      "first_name": "Dana",
      "last_name": "Whitfield",
      "business_email": "dana@northlinelogistics.com",
      "job_title": "VP of Operations",
      "professional_city": "Austin",
      "professional_state": "TX",
      "created_at": "2026-10-27T15:04:01+00:00"
    }
  ],
  "pagination": {
    "current_page": 1,
    "last_page": 37,
    "per_page": 25,
    "total": 911,
    "from": 1,
    "to": 25
  }
}
POST/projects/{identifier}/webhook/configure

Send leads to your webhook

Every new or updated lead is posted to your HTTPS endpoint as JSON. See the event below.

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Request body application/json
webhook_urlstring (url)required

Must start with https://.

webhook_enabledboolean

Default true.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook/configure" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "webhook_url": "https://hooks.example.com/leadfuze",
    "webhook_enabled": true
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook/configure', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "webhook_url": "https://hooks.example.com/leadfuze",
    "webhook_enabled": true
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook/configure",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "webhook_url": "https://hooks.example.com/leadfuze",
        "webhook_enabled": True
    },
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/projects/{identifier}

Get a project

Includes the tracking code and subscription.

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/projects/leq4k7m2x" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
PATCH/projects/{identifier}

Update a project

Change the name, URL or status, or white-label the script with your own tracking_variable and tracking_slug.

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Request body application/json
tracking_variablestring

JavaScript variable name, for example acmeTrack.

tracking_slugstring

Lowercase script path slug.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X PATCH "https://console.leadfuze.com/api/v1/projects/leq4k7m2x" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
});
const data = await res.json();
import os, requests

r = requests.patch(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={},
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/projects/{identifier}/assign

Assign a project to a user

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Request body application/json
user_idintegerrequired

Your user.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/assign" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": 0
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x/assign', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "user_id": 0
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/assign",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "user_id": 0
    },
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/projects/{identifier}/webhook/test

Send a test event

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook/test" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook/test', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook/test",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
DELETE/projects/{identifier}/webhook

Remove the webhook

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X DELETE "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.delete(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/projects/{identifier}/webhook/events

Webhook delivery log

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook/events" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook/events', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/webhook/events",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/projects/{identifier}/subscription

Project billing status

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscription" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscription', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscription",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
DELETE/projects/{identifier}/subscription

Cancel a project subscription

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X DELETE "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscription" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscription', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.delete(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscription",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/projects/{identifier}/subscribe

Start billing for a project

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscribe" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscribe', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscribe",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/projects/{identifier}/subscription/resume

Resume a canceled subscription

Path parameters
identifierstringrequired

The project_identifier (or numeric id) of the pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscription/resume" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscription/resume', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/projects/leq4k7m2x/subscription/resume",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/project-leads

Leads by project id

Query parameters
project_idintegerrequired

Numeric project id.

pageinteger
per_pageinteger

1 to 100.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X GET "https://console.leadfuze.com/api/v1/project-leads?project_id=812" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/project-leads?project_id=812', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/project-leads?project_id=812",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/leads/{id}

Get one lead

Path parameters
idintegerrequired

Lead id.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X GET "https://console.leadfuze.com/api/v1/leads/440193" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/leads/440193', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/leads/440193",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
Integrations

Integrations API

Deliver pixel leads straight to HubSpot, Pipedrive, Slack, email and the major email marketing tools.

Destinations

{type} is one of hubspot, pipedrive, slack, email, brevo, mailchimp, activecampaign, klaviyo, kit, constantcontact, getresponse or beehiiv.

POST/integrations/{type}/configure

Connect a destination

Send a pixel project's leads to a CRM, email tool, Slack or an inbox.

Path parameters
typestringrequired

One of hubspot, pipedrive, slack, email, brevo, mailchimp, activecampaign, klaviyo, kit, constantcontact, getresponse, beehiiv.

Request body application/json
project_identifierstringrequired

The pixel project.

api_keystring

The destination's API key, where it uses one.

webhook_urlstring (url)

For Slack and similar.

configobject

Destination settings, such as a list id.

is_enabledboolean

Default true.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/integrations/hubspot/configure" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_identifier": "leq4k7m2x",
    "api_key": "YOUR_HUBSPOT_PRIVATE_APP_TOKEN",
    "is_enabled": true
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/integrations/hubspot/configure', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "project_identifier": "leq4k7m2x",
    "api_key": "YOUR_HUBSPOT_PRIVATE_APP_TOKEN",
    "is_enabled": true
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/integrations/hubspot/configure",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "project_identifier": "leq4k7m2x",
        "api_key": "YOUR_HUBSPOT_PRIVATE_APP_TOKEN",
        "is_enabled": True
    },
)
print(r.json())
Response200application/json
{
  "success": true
}
GET/integrations

List connected destinations

Query parameters
project_identifierstringrequired

The pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
Request
curl -X GET "https://console.leadfuze.com/api/v1/integrations?project_identifier=leq4k7m2x" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY"
const res = await fetch('https://console.leadfuze.com/api/v1/integrations?project_identifier=leq4k7m2x', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`
  }
});
const data = await res.json();
import os, requests

r = requests.get(
    "https://console.leadfuze.com/api/v1/integrations?project_identifier=leq4k7m2x",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/integrations/{type}/test

Send a test contact

Path parameters
typestringrequired

One of hubspot, pipedrive, slack, email, brevo, mailchimp, activecampaign, klaviyo, kit, constantcontact, getresponse, beehiiv.

Request body application/json
project_identifierstringrequired

The pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/integrations/hubspot/test" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_identifier": "leq4k7m2x"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/integrations/hubspot/test', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "project_identifier": "leq4k7m2x"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/integrations/hubspot/test",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "project_identifier": "leq4k7m2x"
    },
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/integrations/{type}/retry

Retry failed deliveries

Path parameters
typestringrequired

One of hubspot, pipedrive, slack, email, brevo, mailchimp, activecampaign, klaviyo, kit, constantcontact, getresponse, beehiiv.

Request body application/json
project_identifierstringrequired

The pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/integrations/hubspot/retry" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_identifier": "leq4k7m2x"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/integrations/hubspot/retry', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "project_identifier": "leq4k7m2x"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/integrations/hubspot/retry",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "project_identifier": "leq4k7m2x"
    },
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/integrations/{type}/disconnect

Disconnect a destination

Path parameters
typestringrequired

One of hubspot, pipedrive, slack, email, brevo, mailchimp, activecampaign, klaviyo, kit, constantcontact, getresponse, beehiiv.

Request body application/json
project_identifierstringrequired

The pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/integrations/hubspot/disconnect" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_identifier": "leq4k7m2x"
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/integrations/hubspot/disconnect', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "project_identifier": "leq4k7m2x"
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/integrations/hubspot/disconnect",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "project_identifier": "leq4k7m2x"
    },
)
print(r.json())
Response200application/json
{
  "success": true
}
POST/integrations/{type}/send

Push one contact now

Path parameters
typestringrequired

One of hubspot, pipedrive, slack, email, brevo, mailchimp, activecampaign, klaviyo, kit, constantcontact, getresponse, beehiiv.

Request body application/json
contactobjectrequired

The contact to send.

project_identifierstring

The pixel project.

Responses
200OK
401Missing, invalid or inactive API key.
422The request did not pass validation.
429More than 1,000 requests in a minute.
404Not found, or not yours.
Request
curl -X POST "https://console.leadfuze.com/api/v1/integrations/hubspot/send" \
  -H "Authorization: Bearer $LEADFUZE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contact": {}
  }'
const res = await fetch('https://console.leadfuze.com/api/v1/integrations/hubspot/send', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADFUZE_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "contact": {}
  })
});
const data = await res.json();
import os, requests

r = requests.post(
    "https://console.leadfuze.com/api/v1/integrations/hubspot/send",
    headers={"Authorization": f"Bearer {os.environ['LEADFUZE_API_KEY']}"},
    json={
        "contact": {}
    },
)
print(r.json())
Response200application/json
{
  "success": true
}
Schemas

Lead record: 60 fields

Every revealed or exported person carries up_id, cc_id and these 60 fields, in eight groups. Each one is also a filter: the right column shows how it matches and whether it has an on-file filter. Example values belong to a made-up person.

FieldLabelExampleFilter
PersonWho they are and where to find them online.
first_nameFirst nameDanaexact, on file
last_nameLast nameWhitfieldexact, on file
linkedin_urlLinkedIn URLlinkedin.com/in/danawhitfieldexact, on file
social_connectionsSocial connections500+phrase or exact, on file
JobTitle as written, a normalized title, and two takes on seniority and department.
job_titleJob titleVP of Operationsexact or phrase, on file
job_title_normalizedJob title normalizedvice president of operationsexact, on file
seniority_levelSeniority levelVpexact, on file
seniority_level_2Seniority level 2vice presidentexact, on file
departmentDepartmentOperationsexact, on file
department_2Department 2operationsexact, on file
ContactWork and personal emails with validation status, mobile, direct and personal phones.
business_emailBusiness emaildana@northlinelogistics.comexact, on file
business_email_validation_statusBusiness email validation statusValid (Esp)exact, on file
programmatic_business_emailsProgrammatic business emailsdana.whitfield@northlinelogistics.comexact, on file
historical_programmatic_emailsHistorical programmatic emailsdwhitfield@ridgewayfreight.comexact, on file
mobile_phoneMobile phone15125550148exact, on file
direct_numberDirect number+15125550190exact, on file
personal_phonePersonal phone+15125550173exact, on file
personal_emailsPersonal emailsdanawhitfield@gmail.comexact, on file
additional_personal_emailsAdditional personal emailsdana.w4@yahoo.comexact, on file
personal_emails_validation_statusPersonal emails validation statusValid (Esp)exact, on file
CompanyFirmographics on the employer, from industry codes to revenue and headquarters.
company_nameCompany nameNorthline Logisticsexact or phrase, on file
company_domainCompany domainnorthlinelogistics.comexact, on file
related_domainsRelated domainsnorthline.ioexact, on file
company_descriptionCompany descriptionRegional freight and warehousing for retailersphrase or exact, on file
primary_industryPrimary industryTruck Transportationexact, on file
company_sicCompany SIC4213exact, on file
company_naicsCompany NAICS484121exact, on file
company_employee_countCompany employee count251 to 500exact, on file
company_revenueCompany revenue50 Million to 100 Millionexact, on file
company_phoneCompany phone+15125550100exact, on file
company_linkedin_urlCompany LinkedIn URLlinkedin.com/company/northlinelogisticsexact, on file
company_addressCompany address400 Commerce Wayexact, on file
company_cityCompany cityAustinexact, on file
company_stateCompany stateTXexact, on file
company_zipCompany ZIP78744exact, on file
company_countryCompany countryUSexact, on file
Work addressWhere they work, down to the ZIP+4.
professional_addressProfessional address400 Commerce Wayexact, on file
professional_address_2Professional address 2Suite 210exact, on file
professional_cityProfessional cityAustinexact, on file
professional_stateProfessional stateTXexact, on file
professional_zipProfessional ZIP78744exact, on file
professional_zip4Professional ZIP41207exact, on file
contact_countryContact countryUSexact, on file
Home addressPostal address with a delivery point validation code.
personal_addressPersonal address1180 Oak Ridge Drexact, on file
personal_address_2Personal address 2nullexact, on file
personal_cityPersonal cityRound Rockexact, on file
personal_statePersonal stateTXexact, on file
personal_zipPersonal ZIP78681exact, on file
personal_zip4Personal ZIP43342exact, on file
dpv_codeDPV codeYexact, on file
HouseholdDemographics for B2C targeting and audience matching.
genderGenderFexact, on file
age_rangeAge range45-54exact, on file
dobDate of birthnullexact, on file
marriedMarriedYexact, on file
childrenChildrenYexact, on file
homeownerHomeownerYexact, on file
income_rangeIncome range$150,000 to $199,999exact, on file
net_worthNet worth$500,000 to $749,999exact, on file
HistoryPast roles and schools, so you know where they have been.
work_historyWork historyDirector of Operations, Ridgeway Freight, 2014 to 2019phrase or exact, on file
education_historyEducation historyUniversity of Texas, BS, Business Administrationphrase or exact, on file

Allowed values

Fields with a fixed list match these values exactly. GET /leads-database/catalog returns the same lists as choices.

company_employee_count
1 to 1011 to 2526 to 5051 to 100101 to 250251 to 500501 to 10001001 to 50005001 to 1000010000+
company_revenue
Under 1 Million1 Million to 5 Million5 Million to 10 Million10 Million to 25 Million25 Million to 50 Million50 Million to 100 Million100 Million to 250 Million250 Million to 500 Million500 Million to 1 Billion1 Billion and Over
seniority_level
StaffManagerDirectorVpCxo
department
AdministrativeCommunity And Social ServicesEducationEngineeringExecutiveFinanceGovernmentHealth ServicesHuman ResourcesInformation TechnologyLegalMarketingMedia And CommunicationsMilitary And Protective ServicesOperationsProduct ManagementReal EstateSales
age_range
18-2425-3435-4445-5455-6465 and older
income_range
Less than $20,000$20,000 to $44,999$45,000 to $59,999$60,000 to $74,999$75,000 to $99,999$100,000 to $149,999$150,000 to $199,999$200,000 to $249,000$250,000+
net_worth
-$20,000 to -$2,500-$2,499 to $2,499$2,500 to $24,999$25,000 to $49,999$50,000 to $74,999$75,000 to $99,999$100,000 to $149,999$150,000 to $249,999$250,000 to $374,999$375,000 to $499,999$500,000 to $749,999$750,000 to $999,999More than $1,000,000
social_connections
1-910-99100-249250-499500+
business_email_validation_status
Valid (Esp)Valid (Catch-All)Valid (Digital)
seniority_level_2
entrymanagersenior individual contributordirectorcxoownervice presidentpartnerunpaidtraining
primary_industry361 industries, for example Software Development, Truck Transportation and Hospitals And Health Care. The full list is in the catalog.

Criteria

Who to find. Fields are combined with AND; values inside one include list with OR; any exclude removes a person.

querystring

Free text across name, job title, company name, industry, city and state. A complete email, phone, domain or LinkedIn URL runs an exact lookup.

max length 500, default ""
lookup_typestring or null

Force an exact lookup of query. email checks all five email columns; phone all four phone columns; id uses up_id.

emailphonedomainlinkedinid
job_titlesJobTitles
Show 3 child attributes
includestring[]

Whole words or phrases matched inside job_title. Any one is enough.

max items 20
excludestring[]

Remove titles containing any of these. Overrides include.

max items 20
similarboolean

Also match common variants: CEO and Chief Executive Officer, VP of X and Vice President of X, Founder and Co-Founder. At most 20 titles after expansion.

default true
filtersobject

Keyed by catalog field. At most 200 include and exclude values across all filters.

Show filter value shapes

One key per catalog field (see all fields). Fields that start with has_ take an AvailabilityFilter. Every other field takes a FieldCondition.

FieldCondition
includestring[]

Keep people whose value matches any of these.

max items 20
excludestring[]

Remove people whose value matches any of these. A person with no value passes an exclude-only rule.

max items 20
matchstring

exact compares the whole value, ignoring case. phrase finds whole words inside the text and works on job_title, company_name, work_history, education_history, company_description, social_connections. Default phrase for work_history, education_history, company_description, social_connections, exact for the rest.

exactphrase
presencestring

Only people with this field on file, or only people without it.

hasmissing
AvailabilityFilter
valuebooleanrequired
limitinteger

Results per page.

min 1, max 50, default 25
Criteria
{
  "query": "",
  "job_titles": {
    "include": ["VP of Operations", "Director of Operations"],
    "exclude": ["Assistant"],
    "similar": true
  },
  "filters": {
    "primary_industry": {
      "include": ["Truck Transportation", "Warehousing And Storage"]
    },
    "company_employee_count": {
      "include": ["101 to 250", "251 to 500"]
    },
    "state": {
      "include": ["Texas", "OK"]
    },
    "company_description": {
      "include": ["cold chain"],
      "match": "phrase"
    },
    "company_domain": {
      "exclude": ["competitor.com"]
    },
    "mobile_phone": {
      "presence": "has"
    },
    "has_business_email": {
      "value": true
    }
  },
  "limit": 25
}

Enrichment profile

A person from the enrichment API. Company fields are nested under company and LinkedIn data under social.

up_idstring or null
first_namestring or null
last_namestring or null
full_namestring or null
business_emailstring or null
personal_emailsstring or null
additional_personal_emailsstring or null
programmatic_business_emailsstring or null
mobile_phonestring or null
direct_numberstring or null
personal_phonestring or null
linkedin_urlstring or null
personal_addressstring or null
personal_address_2string or null
personal_citystring or null
personal_statestring or null
personal_zipstring or null
personal_zip4string or null
full_addressstring or null
genderstring or null
age_rangestring or null
income_rangestring or null
net_worthstring or null
marriedstring or null
childrenstring or null
homeownerstring or null
dobstring or null
job_titlestring or null
seniority_levelstring or null
departmentstring or null
professional_addressstring or null
professional_address_2string or null
professional_citystring or null
professional_statestring or null
professional_zipstring or null
professional_zip4string or null
professional_full_addressstring or null
business_email_validation_statusstring or null
business_email_last_seenstring or null
personal_emails_validation_statusstring or null
personal_emails_last_seenstring or null
last_updatedstring or null
created_atstring or null
updated_atstring or null
companyCompany
Show 17 child attributes
namestring or null
domainstring or null
phonestring or null
sicstring or null
addressstring or null
citystring or null
statestring or null
zipstring or null
countrystring or null
linkedin_urlstring or null
revenuestring or null
employee_countstring or null
primary_industrystring or null
descriptionstring or null
naicsstring or null
related_domainsstring or null
last_updatedstring or null
socialobject
Show 2 child attributes
linkedin_urlstring or null
social_connectionsstring or null
Profile
{
  "up_id": "up_8c41d2e7a9",
  "first_name": "Dana",
  "last_name": "Whitfield",
  "full_name": "Dana Whitfield",
  "business_email": "dana@northlinelogistics.com",
  "personal_emails": "danawhitfield@gmail.com",
  "additional_personal_emails": "dana.w4@yahoo.com",
  "programmatic_business_emails": "dana.whitfield@northlinelogistics.com",
  "mobile_phone": "15125550148",
  "direct_number": "+15125550190",
  "personal_phone": "+15125550173",
  "linkedin_url": "linkedin.com/in/danawhitfield",
  "personal_address": "1180 Oak Ridge Dr",
  "personal_address_2": null,
  "personal_city": "Round Rock",
  "personal_state": "TX",
  "personal_zip": "78681",
  "personal_zip4": "3342",
  "full_address": "1180 Oak Ridge Dr, Round Rock, TX 78681",
  "gender": "F",
  "age_range": "45-54",
  "income_range": "$150,000 to $199,999",
  "net_worth": "$500,000 to $749,999",
  "married": "Y",
  "children": "Y",
  "homeowner": "Y",
  "dob": null,
  "job_title": "VP of Operations",
  "seniority_level": "Vp",
  "department": "Operations",
  "professional_address": "400 Commerce Way",
  "professional_address_2": "Suite 210",
  "professional_city": "Austin",
  "professional_state": "TX",
  "professional_zip": "78744",
  "professional_zip4": "1207",
  "professional_full_address": "400 Commerce Way, Suite 210, Austin, TX 78744",
  "business_email_validation_status": "Valid (Esp)",
  "business_email_last_seen": "2026-10-12",
  "personal_emails_validation_status": "Valid (Esp)",
  "personal_emails_last_seen": "2026-09-28",
  "last_updated": "2026-10-01",
  "created_at": "2026-10-27T15:04:05.000000Z",
  "updated_at": "2026-10-27T15:04:05.000000Z",
  "company": {
    "name": "Northline Logistics",
    "domain": "northlinelogistics.com",
    "phone": "+15125550100",
    "sic": "4213",
    "address": "400 Commerce Way",
    "city": "Austin",
    "state": "TX",
    "zip": "78744",
    "country": "US",
    "linkedin_url": "linkedin.com/company/northlinelogistics",
    "revenue": "50 Million to 100 Million",
    "employee_count": "251 to 500",
    "primary_industry": "Truck Transportation",
    "description": "Regional freight and warehousing for retailers",
    "naics": "484121",
    "related_domains": "northline.io",
    "last_updated": "2026-10-01"
  },
  "social": {
    "linkedin_url": "linkedin.com/in/danawhitfield",
    "social_connections": "500+"
  }
}