Connection
- Authentication: API key.
In Leadfeeder (Dealfront): Settings → Personal tab → API Keys → “Create a new API key”. The value is shown once, copy it then. API access only exists on a trial and on paid plans (Discover and above), not on the free Lite plan.See Leadfeeder’s documentation.
Read actions (16)
| Action | Description |
|---|---|
get_companies | Retrieve companies by their ids, with full deep data. Arguments: ids (required, array of company id strings, sent comma-separated); account_id (required); include (string, e.g. tags, lists, web_visits, icps, crm_connections…). Credit note: each company consumes 1 credit unless it was already accessed within the last 12 months. |
get_company | Get one company by id, with firmographics and hierarchy. Arguments: id (string, Leadfeeder company id, in the path); account_id (required); include (string, e.g. tags, lists, web_visits, icps…). Credit note: accessing full deep data consumes 1 credit unless the company was accessed within the last 12 months. |
get_company_financials | Get the financial reports available for a company. Arguments: id (string, Leadfeeder company id, in the path); account_id (required). Credit note: consumes 1 credit per company only if financial data is available and there was no active deep-data access within the last 12 months. |
get_current_user | Get the current API user (id, e-mail, first and last name, phone, country, team role). Needs no account_id. |
get_custom_feed | Get one web-visits custom feed by id (name, folder, filters). Arguments: custom_feed_id (string, from list_custom_feeds, in the path); account_id (required); include (string, folder and/or connected_list). |
get_list | Get one list by id (name, scope, list_type). Arguments: id (string, scope-prefixed list id such as company_123, from list_lists, in the path); account_id (required). Retrieving a list does not consume credits. |
get_usage | Get the API usage per endpoint for an account over a period (successful and failed request counts). Arguments: account_id (required); start_period and end_period (required, YYYY-MM). |
list_accounts | Check the API key and list the Leadfeeder accounts it can access. Without account_id: every account with its name only; with account_id: that account with its credit details. The account_id to pass to every other action comes from here. |
list_custom_feeds | List the web-visits custom feeds of an account. Arguments: account_id (required); include (string, folder and/or connected_list) adds the folder and the connected list; filter_has_connected_list (boolean) keeps only feeds with (true) or without (false) a connected list. |
list_goals | List the goals of an account (a page-view condition marking buying intent, e.g. a pricing-page view). Argument: account_id (required). Retrieving goals does not consume credits. |
list_list_items | List the members of a list as bare references (ids only): give them to get_companies. Arguments: id (string, scope-prefixed list id, in the path); account_id (required); page_cursor (string, page[cursor] from the previous page); page_size (integer 1 to 100, default 20). Retrieving members does not consume credits. |
list_lists | List the lists of an account. Arguments: account_id (required); scope (required, company or contact — sent as filter[scope], it is mandatory); page_num (integer >= 1); page_size (integer 1 to 100, default 20). Retrieving lists does not consume credits. |
list_tags | List the tags of an account (id, name, colour) — the ids used by add_tags_to_company. Arguments: account_id (required); page_num (integer >= 1); page_size (integer 1 to 100, default 20). Retrieving tags does not consume credits. |
list_visiting_companies | List the companies that visited your website within a date range, each with its inferred geographic location. Arguments: account_id (required); start_date and end_date (required, YYYY-MM-DD, inclusive); custom_feed_id (string, only that custom feed); include=company (string) adds the company object; page_num (integer >= 1); page_size (integer 1 to 100, default 20). Reading web visits does not consume credits. |
search_companies | Search companies by criteria (a read: POST carries the search body). Arguments: account_id (required, query); at least one of search_terms (string[]), locations (array of { street, postal_code, city, country_code, region_code, geo:{ latitude, longitude, distance } }), industries { classification: internal|wz|nace, codes: string[] }, employee_ranges (array of “1-10”, “11-100”, “101-500”, “501-1.000”, “1.001-5.000”, “5.001-10.000”, “10.000+”), revenue { min, max } (EUR), icp_ids (string[]), filters { do_not_contact, has_email, has_financials_earnings, has_financials_net_worth, has_financials_revenue, has_ip_addresses, has_phone, has_social_media_profiles } (booleans); page_cursor (string); page_size (integer 1 to 100, default 20). Credit note: searches do not consume credits; credits are only used if you then retrieve deep data for a company not accessed within the last 12 months. |
search_web_visits | Search web visits within a date range (a read: POST carries the filter body). Arguments: account_id (required, query); start_date and end_date (required, YYYY-MM-DD, inclusive); filters — simple inline filters { company_id (string), location_cities (string[]), location_country_codes (string[], ISO 3166-1 alpha-2) } — or advanced_filters (object, a fixed custom-feed-style filter tree), one or the other, never both; include=company (string); page_num (integer >= 1); page_size (integer 1 to 100, default 20). Searching web visits does not consume credits. |
Write actions (10)
| Action | Description |
|---|---|
add_companies_to_list | Add a company to one or more company lists. Arguments: id (string, company id, in the path); account_id (required, query); list_ids (array of company list id strings, required — e.g. company_123, from list_lists with scope company). Adding a company to lists does not consume credits. |
add_contacts_to_list | Add a contact to one or more contact lists. Arguments: id (string, contact id, in the path); account_id (required, query); list_ids (array of contact list id strings, required — e.g. contact_456, from list_lists with scope contact). Adding a contact to lists does not consume credits. |
add_tags_to_company | Assign one or more tags to a company. Arguments: id (string, company id, in the path); account_id (required, query); tag_ids (array of tag id strings, required — from list_tags). Assigning tags does not consume credits. |
create_list | Create a list. Arguments: account_id (required, query); name (string, required); scope (string, required: company or contact). Creating a list does not consume credits. |
create_tag | Create a tag that can be assigned to companies. Arguments: account_id (required, query); name (string, required); color (integer 0 to 9, required — 0 #1B70F0, 1 #08A360, 2 #AE540D, 3 #D42422, 4 #5A219B, 5 #073572, 6 #00838F, 7 #D42422, 8 #B61A5C, 9 #4C3AED). Creating tags does not consume credits. |
remove_companies_from_list | Remove a company from one or more company lists. Arguments: id (string, company id, in the path); account_id (required, query); list_ids (array of company list id strings, required). Removing a company from lists does not consume credits. |
remove_contacts_from_list | Remove a contact from one or more contact lists. Arguments: id (string, contact id, in the path); account_id (required, query); list_ids (array of contact list id strings, required). Removing a contact from lists does not consume credits. |
remove_tags_from_company | Unassign one or more tags from a company (it removes the association, not the tag). Arguments: id (string, company id, in the path); account_id (required, query); tag_ids (array of tag id strings, required). Unassigning tags does not consume credits. |
update_list | Rename a list. Arguments: id (string, scope-prefixed list id, in the path); account_id (required, query); name (string, required). Updating a list does not consume credits. |
update_tag | Update a tag — only the fields you pass change. Arguments: id (string, tag id, in the path); account_id (required, query); name (string); color (integer 0 to 9). At least one of name or color is required. Updating tags does not consume credits. |
Permissions
Every action above must be explicitly granted to an agent before it can be used. See Permissions for the grant model and Security for how credentials are protected.Last reviewed against the provider API: October 2026.