# Leadfeeder API ## Docs - [Leadfeeder API](https://docs.leadfeeder.com/api/public/leadfeeder-api-354545m0.md): - [Authentication](https://docs.leadfeeder.com/api/public/authentication-354547m0.md): - [Getting Started](https://docs.leadfeeder.com/api/public/getting-started-363633m0.md): - [Rate Limits](https://docs.leadfeeder.com/api/public/rate-limits-354549m0.md): - [Relationships](https://docs.leadfeeder.com/api/public/relationships-356675m0.md): - [Company ID Lifecycle](https://docs.leadfeeder.com/api/public/company-id-lifecycle-358388m0.md): - [Service Users](https://docs.leadfeeder.com/api/public/service-users-374345m0.md): - [OpenAPI Specification Access](https://docs.leadfeeder.com/api/public/openapi-specification-access-362786m0.md): - [List of NACE / WZ codes](https://docs.leadfeeder.com/api/public/list-of-nace-wz-codes-373879m0.md): - [List of Industries](https://docs.leadfeeder.com/api/public/list-of-industries-370501m0.md): - AI & MCP [Overview of the Leadfeeder MCP Server](https://docs.leadfeeder.com/api/public/overview-of-the-leadfeeder-mcp-server-370532m0.md): - AI & MCP [Quickstart](https://docs.leadfeeder.com/api/public/quickstart-370533m0.md): - AI & MCP [Connect your AI tool](https://docs.leadfeeder.com/api/public/connect-your-ai-tool-370534m0.md): - AI & MCP [ Authentication and permissions](https://docs.leadfeeder.com/api/public/-authentication-and-permissions-370535m0.md): - Web Visits [How to Create Custom Feed](https://docs.leadfeeder.com/api/public/how-to-create-custom-feed-363485m0.md): - Web Visits [Custom Feed - Filter Reference](https://docs.leadfeeder.com/api/public/custom-feed-filter-reference-363484m0.md): ## API Docs - Account [List Accounts](https://docs.leadfeeder.com/api/public/list-accounts-4008950e0.md): Retrieves a list of Leadfeeder accounts associated with this API key. Without `account_id`, all accounts are listed without their credit details. With `account_id`, only that account is returned, including its credit details. Pass `include=subscriptions` to also get each account's current and upcoming subscriptions. - Companies [Retrieve Companies](https://docs.leadfeeder.com/api/public/retrieve-companies-4008952e0.md): Retrieve the list of companies based on provided IDs. - Companies [Create Company Enrichment Job](https://docs.leadfeeder.com/api/public/create-company-enrichment-job-4327332e0.md): Trigger an asynchronous job to enrich companies with AI-generated custom field values. The custom field must exist and be an AI field type (`ai_score`, `ai_text`, `ai_number`, `ai_boolean`) or a `contact_collection` field. Create custom fields via the Custom Fields API first. - Companies [Estimate Company Enrichment Job](https://docs.leadfeeder.com/api/public/estimate-company-enrichment-job-4327331e0.md): Estimate the credit cost for enriching companies with AI-generated custom field values. Target the estimate with a specific `list_id`, flat `company_ids`, or a pre-computed `company_count`. - Companies [Get Company Enrichment Job Status](https://docs.leadfeeder.com/api/public/get-company-enrichment-job-status-4327333e0.md): Retrieve the current status of a Company AI Enrichment job, with any errors. `credits.estimated` is set when the job is created if it targets `company_ids`, and otherwise once the job has found the companies to enrich. `credits.consumed` is reported once the job has finished. The counts in `summary` can appear shortly before `status` changes. - Companies [Retrieve Company IPs](https://docs.leadfeeder.com/api/public/retrieve-company-ips-4211935e0.md): Fetch known IP addresses associated with a given set of companies, enabling identification of web traffic and network activity linked to those organizations based on the provided company IDs. - Companies [Match Companies](https://docs.leadfeeder.com/api/public/match-companies-4008956e0.md): Find matching companies based on the provided input parameters. - Companies [Search Companies](https://docs.leadfeeder.com/api/public/search-companies-4008955e0.md): Perform search queries using criteria like name, location, industry, size or filters like `has_phone`. - Companies [Search Company Signals](https://docs.leadfeeder.com/api/public/search-company-signals-4008954e0.md): Retrieve signals for a specified set of company IDs. The response returns the signals linked to the provided companies. - Companies [Get Company Details](https://docs.leadfeeder.com/api/public/get-company-details-4008951e0.md): Fetch detailed information about a specific company, including firmographics and hierarchy information based on the provided Leadfeeder company_id. - Companies [Update a Company](https://docs.leadfeeder.com/api/public/update-a-company-4455064e0.md): Update a company. - Companies [Company Financial Reports](https://docs.leadfeeder.com/api/public/company-financial-reports-4008953e0.md): Returns all financial reports for a given company. - Companies [Remove Company from Lists](https://docs.leadfeeder.com/api/public/remove-company-from-lists-4045442e0.md): Allows the removal of this company from one or more lists. - Companies [Add Company to Lists](https://docs.leadfeeder.com/api/public/add-company-to-lists-4045441e0.md): Allows the addition of this company to one or more lists. Since lists are a separate entity, the IDs that you must pass in this endpoint come from the **Retrieve Lists** and **Get List Details** endpoints. - Companies [Unassign Tags from Company](https://docs.leadfeeder.com/api/public/unassign-tags-from-company-4045444e0.md): Allows the unassignment of one or more tags from a given company. - Companies [Assign Tags to Company](https://docs.leadfeeder.com/api/public/assign-tags-to-company-4045443e0.md): Allows the assignment of one or more tags to a given company. Since tags are a separate entity, the IDs that you must pass in this endpoint come from the **Retrieve Tags** and **Get Tag Details** endpoints. - Contacts [Retrieve Contacts](https://docs.leadfeeder.com/api/public/retrieve-contacts-4008958e0.md): Retrieve a list of contacts based on the provided IDs. - Contacts [Create Find Contact Data Job](https://docs.leadfeeder.com/api/public/create-find-contact-data-job-4327335e0.md): Trigger an asynchronous job to enrich the given contacts with email and phone data. Accepts either explicit `contact_ids` or a `list_id` to target an entire list. The job runs in the background; poll the status endpoint to check progress. - Contacts [Estimate Find Contact Data Job](https://docs.leadfeeder.com/api/public/estimate-find-contact-data-job-4327334e0.md): Estimate the credit cost for enriching contacts with email and phone data. Accepts either explicit `contact_ids` or a `list_id` to target an entire list. Returns the number of eligible contacts and the estimated total credits that would be consumed. - Contacts [Get Find Contact Data Job Status](https://docs.leadfeeder.com/api/public/get-find-contact-data-job-status-4327336e0.md): Retrieve the current status of a Find Contact Data job. Returns progress counters, credit consumption, and any errors. - Contacts [Search Contacts](https://docs.leadfeeder.com/api/public/search-contacts-4008959e0.md): Search for contacts based on the provided search parameters and returns contact summary objects. - Contacts [Get Contact Details](https://docs.leadfeeder.com/api/public/get-contact-details-4008957e0.md): Get the details of a contact by ID. - Contacts [Update a Contact](https://docs.leadfeeder.com/api/public/update-a-contact-4455065e0.md): Update a contact. - Contacts [Remove Contact from Lists](https://docs.leadfeeder.com/api/public/remove-contact-from-lists-4045446e0.md): Allows the removal of this contact from one or more lists. - Contacts [Add Contact to Lists](https://docs.leadfeeder.com/api/public/add-contact-to-lists-4045445e0.md): Allows the addition of this contact to one or more lists. Since lists are a separate entity, the IDs that you must pass in this endpoint come from the **Retrieve Lists** and **Get List Details** endpoints. - Web Visits [Search Web Visits](https://docs.leadfeeder.com/api/public/search-web-visits-4160957e0.md): Search for web visits within a date range. Returns a paginated list of visit records including engagement data, visitor information, and location. Visits can be narrowed with the simple inline `filters` or with a custom-feed-style `advanced_filters` tree (one or the other, not both). - Web Visits [Retrieve Visitor Companies](https://docs.leadfeeder.com/api/public/retrieve-visitor-companies-4160962e0.md): Retrieve a paginated list of companies that visited your website within a given date range. Each item includes references to the company and its inferred geographic location. - Web Visits [Retrieve Custom Feeds](https://docs.leadfeeder.com/api/public/retrieve-custom-feeds-4160958e0.md): Retrieve all custom feeds accessible to the current user for the given account. - Web Visits [Create a Custom Feed](https://docs.leadfeeder.com/api/public/create-a-custom-feed-4186102e0.md): Create a new custom feed for the given account. - Web Visits [Retrieve Custom Feeds Folders](https://docs.leadfeeder.com/api/public/retrieve-custom-feeds-folders-4160960e0.md): Retrieve all custom feed folders accessible to the current user for the given account. - Web Visits [Delete a Custom Feed](https://docs.leadfeeder.com/api/public/delete-a-custom-feed-4186104e0.md): Delete a custom feed by its ID. - Web Visits [Get Custom Feed Details](https://docs.leadfeeder.com/api/public/get-custom-feed-details-4160959e0.md): Retrieve a single custom feed by its ID. - Web Visits [Update Custom Feed](https://docs.leadfeeder.com/api/public/update-custom-feed-4186103e0.md): Update an existing custom feed. All attributes are optional; only provided attributes will be updated. - Web Visits [Retrieve Goals](https://docs.leadfeeder.com/api/public/retrieve-goals-4552012e0.md): Retrieve all goals defined in the account. A goal is a page-view condition — on the page URL or title, a form submission, a file download or a video — that marks the page views signalling buying intent, such as visits to a pricing page. `relationships.custom_feed` links a goal to the Web Visits custom feed listing the companies with a page view meeting it, and a custom feed's `advanced_filters` can filter on the `goal` field with a goal's `id`. - Web Visits [Create a Goal](https://docs.leadfeeder.com/api/public/create-a-goal-4552013e0.md): Create a goal in the account. A goal only marks page views tracked after it is created; earlier visits are not re-checked. The goal's custom feed is created in the background, so `relationships.custom_feed` is usually `null` in the response. - Web Visits [Delete a Goal](https://docs.leadfeeder.com/api/public/delete-a-goal-4552014e0.md): Delete a goal by its ID. Its custom feed is deleted too, and the goal is removed from the page views it marked. The deletion completes in the background, so the goal can still be returned by the other goal endpoints for a short time; the request does not need retrying. - Web Visits [Get Goal Details](https://docs.leadfeeder.com/api/public/get-goal-details-4552015e0.md): Get a goal by its ID, including its name, whether it is enabled and the page-view condition that defines it. - Web Visits [Update a Goal](https://docs.leadfeeder.com/api/public/update-a-goal-4552016e0.md): Update an existing goal. All attributes are optional; only the attributes you send are changed. `criterion` replaces the stored criterion: send its `operator`, and a `value` unless the operator is `is_present` or `is_empty`, which take none. Its `field` can be omitted and cannot be changed — delete the goal and create a new one instead. Changes are not retroactive: page views the goal already marked keep it, and earlier page views are not re-checked. - Web Visits [Retrieve Web Visits Tracker Script](https://docs.leadfeeder.com/api/public/retrieve-web-visits-tracker-script-4160961e0.md): Retrieve the tracking script for the given account. The response includes the script hash and a ready-to-use HTML snippet to embed on your website to enable visitor tracking. - Campaigns [Retrieve Campaigns](https://docs.leadfeeder.com/api/public/retrieve-campaigns-4346720e0.md): Retrieve the list of all campaigns available in the account. Use pagination to control the number of campaigns returned, and include related campaign data, campaign settings, list, or custom feed information when needed. - Campaigns [Get Campaign Details](https://docs.leadfeeder.com/api/public/get-campaign-details-4346721e0.md): Fetch detailed information about a specific campaign using its campaign ID. Use the include parameter to attach related campaign data, campaign settings, list, or custom feed information to the result. - Campaigns [Update Campaign](https://docs.leadfeeder.com/api/public/update-campaign-4346722e0.md): Update a specific campaign using its campaign ID. Supports changes to campaign attributes such as name, budget, status, associated list or custom feed, and campaign settings. - Campaigns [Retrieve Campaign Stats](https://docs.leadfeeder.com/api/public/retrieve-campaign-stats-4346723e0.md): Retrieve statistics for a specific campaign over a defined time period. Use frequency, start_period, and end_period to control how the campaign performance data is grouped and returned. - IP [Enrich Company IP Address](https://docs.leadfeeder.com/api/public/enrich-company-ip-address-4008960e0.md): Enriches an input IP (IPv4/IPv6) with matching company information (if any). - Buyer Personas [Retrieve Buyer Personas](https://docs.leadfeeder.com/api/public/retrieve-buyer-personas-4282805e0.md): Retrieve all buyer personas defined in the account. Each buyer persona is a saved set of contact-level filter criteria (department, job title, location, seniority) used to identify target contacts. - Buyer Personas [Create a Buyer Persona](https://docs.leadfeeder.com/api/public/create-a-buyer-persona-4473758e0.md): Create a new buyer persona in the account. - Buyer Personas [Delete a Buyer Persona](https://docs.leadfeeder.com/api/public/delete-a-buyer-persona-4474858e0.md): Delete a buyer persona by its ID. - Buyer Personas [Get Buyer Persona Details](https://docs.leadfeeder.com/api/public/get-buyer-persona-details-4282806e0.md): Get the details of a specific buyer persona by ID, including its name, creation timestamp, and the full set of filter criteria that define it. - Buyer Personas [Update a Buyer Persona](https://docs.leadfeeder.com/api/public/update-a-buyer-persona-4474857e0.md): Update an existing buyer persona. All attributes are optional; only the attributes you send are changed. Sending `filters` replaces every category, not just the one you name. - Ideal Customer Profiles [Retrieve Ideal Customer Profiles](https://docs.leadfeeder.com/api/public/retrieve-ideal-customer-profiles-4282803e0.md): Retrieve all Ideal Customer Profiles (ICPs) defined in the account. Each ICP is a saved set of company-level filter criteria (employee count, industry, location) used to identify target companies. `relationships.custom_feed` links an ICP to the Web Visits custom feed created alongside it, which lists the visiting companies matching the ICP; it is `null` for the few ICPs that have no feed. - Ideal Customer Profiles [Create an Ideal Customer Profile](https://docs.leadfeeder.com/api/public/create-an-ideal-customer-profile-4473757e0.md): Create a new Ideal Customer Profile (ICP) in the account. Creating an ICP also creates the custom feed that surfaces the companies matching it. - Ideal Customer Profiles [Retrieve Company ICP Matches](https://docs.leadfeeder.com/api/public/retrieve-company-icp-matches-4477697e0.md): Find out which Ideal Customer Profiles each of your companies matches. Pass up to 100 company IDs in `ids` and get one entry per company, in the same order. - Ideal Customer Profiles [Delete an Ideal Customer Profile](https://docs.leadfeeder.com/api/public/delete-an-ideal-customer-profile-4474856e0.md): Delete an ICP by its ID. This also deletes the custom feed created alongside it. - Ideal Customer Profiles [Get Ideal Customer Profile Details](https://docs.leadfeeder.com/api/public/get-ideal-customer-profile-details-4282804e0.md): Get the details of a specific Ideal Customer Profile (ICP) by ID, including its name, creation timestamp, and the full set of filter criteria that define it. `relationships.custom_feed` links the ICP to the Web Visits custom feed created alongside it, which lists the visiting companies matching the ICP; it is `null` for the few ICPs that have no feed. - Ideal Customer Profiles [Update an Ideal Customer Profile](https://docs.leadfeeder.com/api/public/update-an-ideal-customer-profile-4474855e0.md): Update an existing Ideal Customer Profile (ICP). All attributes are optional; only the attributes you send are changed. Sending `filters` replaces every category, not just the one you name. - Tags [Retrieve Tags](https://docs.leadfeeder.com/api/public/retrieve-tags-4033139e0.md): Retrieve the list of all tags available in the account. - Tags [Create Tag](https://docs.leadfeeder.com/api/public/create-tag-4033140e0.md): Create a new tag with the provided attributes. - Tags [Create Batch Add Tags Job](https://docs.leadfeeder.com/api/public/create-batch-add-tags-job-4477693e0.md): Schedule an asynchronous job that adds the tags in `data.attributes.tags` to a set of companies. Every tag is added to every selected company. The companies are supplied either as an explicit `items` array (up to 100 items per request), or as an `advanced_search` selection that is resolved into companies (up to 100,000) when the job runs. To remove tags, use `POST /v1/tags/batch-remove-tags-jobs` — adding and removing are separate jobs. - Tags [Get Batch Add Tags Job](https://docs.leadfeeder.com/api/public/get-batch-add-tags-job-4477694e0.md): Retrieve the status of a batch add-tags job created via `POST /v1/tags/batch-add-tags-jobs`. - Tags [Create Batch Remove Tags Job](https://docs.leadfeeder.com/api/public/create-batch-remove-tags-job-4477695e0.md): Schedule an asynchronous job that removes the tags in `data.attributes.tags` from a set of companies. Every tag is removed from every selected company. The companies are supplied either as an explicit `items` array (up to 100 items per request), or as an `advanced_search` selection that is resolved into companies (up to 100,000) when the job runs. To add tags, use `POST /v1/tags/batch-add-tags-jobs` — adding and removing are separate jobs. - Tags [Get Batch Remove Tags Job](https://docs.leadfeeder.com/api/public/get-batch-remove-tags-job-4477696e0.md): Retrieve the status of a batch remove-tags job created via `POST /v1/tags/batch-remove-tags-jobs`. - Tags [Delete Tag](https://docs.leadfeeder.com/api/public/delete-tag-4033143e0.md): Delete a specific tag identified by its ID - Tags [Get Tag Details](https://docs.leadfeeder.com/api/public/get-tag-details-4033141e0.md): Fetch the details of a specific tag using its unique tag ID. - Tags [Update Tag](https://docs.leadfeeder.com/api/public/update-tag-4033142e0.md): Update the attributes of a specific tag identified by its ID. - Lists [Retrieve Lists](https://docs.leadfeeder.com/api/public/retrieve-lists-4033729e0.md): Retrieve all lists available in the account. - Lists [Create a List](https://docs.leadfeeder.com/api/public/create-a-list-4033730e0.md): Create a new list in the account. - Lists [Create Batch Add to List Job](https://docs.leadfeeder.com/api/public/create-batch-add-to-list-job-4455060e0.md): Schedule an asynchronous job that adds members to a single list. The target list is identified by `data.attributes.list_id` in the request body; its prefix (`company_` or `contact_`) determines whether `company` or `contact` references are accepted. You need permission to change the list's members, and it can't be a read-only list, such as a revealed, CRM or custom feed list. The members are supplied either as an explicit `data.attributes.items` array (up to 100 items per request), or — for company lists only — as a `data.attributes.advanced_search` selection that is resolved into companies (up to 100,000) when the job runs. A list holds at most 1,000,000 members. To remove members, use `POST /v1/lists/batch-remove-from-list-jobs` — adding and removing are separate jobs. - Lists [Get Batch Add to List Job](https://docs.leadfeeder.com/api/public/get-batch-add-to-list-job-4455061e0.md): Retrieve the status of a batch add-to-list job created via `POST /v1/lists/batch-add-to-list-jobs`. - Lists [Create Batch Remove from List Job](https://docs.leadfeeder.com/api/public/create-batch-remove-from-list-job-4455062e0.md): Schedule an asynchronous job that removes members from a single list. The target list is identified by `data.attributes.list_id` in the request body; its prefix (`company_` or `contact_`) determines whether `company` or `contact` references are accepted. You need permission to change the list's members, and it can't be a read-only list, such as a revealed, CRM or custom feed list. The members are supplied either as an explicit `data.attributes.items` array (up to 100 items per request), or — for company lists only — as a `data.attributes.advanced_search` selection that is resolved into the list's matching companies (up to 100,000) when the job runs. To add members, use `POST /v1/lists/batch-add-to-list-jobs` — adding and removing are separate jobs. - Lists [Get Batch Remove from List Job](https://docs.leadfeeder.com/api/public/get-batch-remove-from-list-job-4455063e0.md): Retrieve the status of a batch remove-from-list job created via `POST /v1/lists/batch-remove-from-list-jobs`. - Lists [Retrieve Company List Memberships](https://docs.leadfeeder.com/api/public/retrieve-company-list-memberships-4477691e0.md): Find out which lists each of your companies belongs to. Pass up to 100 company IDs in `ids` and get one entry per company, in the same order. - Lists [Retrieve Contact List Memberships](https://docs.leadfeeder.com/api/public/retrieve-contact-list-memberships-4477692e0.md): Find out which lists each of your contacts belongs to. Pass up to 100 contact IDs in `ids` and get one entry per contact, in the same order. - Lists [Delete List](https://docs.leadfeeder.com/api/public/delete-list-4033733e0.md): Delete a list from the account. - Lists [Get List Details](https://docs.leadfeeder.com/api/public/get-list-details-4033731e0.md): Retrieve the details of a specific list using its unique ID. - Lists [Update List](https://docs.leadfeeder.com/api/public/update-list-4033732e0.md): Update the name of a list. - Lists [Retrieve List Items](https://docs.leadfeeder.com/api/public/retrieve-list-items-4455071e0.md): Retrieve the members of a list. The list is addressed by its `{id}`, a scope-prefixed list identifier (e.g. `company_123` or `contact_456`). There is a single `List` resource: the list's `list_type` determines whether the members are companies or contacts. - Custom Fields [Retrieve Custom Fields](https://docs.leadfeeder.com/api/public/retrieve-custom-fields-4043621e0.md): Retrieve the list of all custom field definitions available in the account. - Custom Fields [Create Custom Field](https://docs.leadfeeder.com/api/public/create-custom-field-4043622e0.md): Create a new custom field in the account. - Custom Fields [Delete Custom Field](https://docs.leadfeeder.com/api/public/delete-custom-field-4043625e0.md): Delete a custom field from the account. - Custom Fields [Get Custom Field Details](https://docs.leadfeeder.com/api/public/get-custom-field-details-4043623e0.md): Fetch the details of a specific custom field using its internal name. - Custom Fields [Update Custom Field](https://docs.leadfeeder.com/api/public/update-custom-field-4043624e0.md): Update an existing custom field's name and/or configuration. - Users [Get Current User](https://docs.leadfeeder.com/api/public/get-current-user-4402980e0.md): Retrieves the identity of the current API user - a "whoami" endpoint. - Settings [Get Cookie Consent Settings](https://docs.leadfeeder.com/api/public/get-cookie-consent-settings-4482318e0.md): Returns the account's cookie consent management state. - Settings [Update Cookie Consent Settings](https://docs.leadfeeder.com/api/public/update-cookie-consent-settings-4482319e0.md): Toggles cookie consent management for the account. When enabled, the Leadfeeder tracker does not set its cookie on page load until the visitor grants consent. Integration cookies cannot be modified through the API. - Settings [Get Data Processing Settings](https://docs.leadfeeder.com/api/public/get-data-processing-settings-4482314e0.md): Returns the current "Allow third-party providers" state for the account and its full change history, ordered most-recent-first. Each changelog entry records what was set, who set it, and when. - Settings [Update Data Processing Settings](https://docs.leadfeeder.com/api/public/update-data-processing-settings-4482315e0.md): Enables or disables third-party data enrichment providers for the account. Disabling stops contact data enrichment via third-party providers. The change is recorded in the changelog with the acting API user's identity. - Usage [Get Endpoints Usage](https://docs.leadfeeder.com/api/public/get-endpoints-usage-4008961e0.md): Access usage statistics for various API endpoints for monitoring and auditing purposes. - Reference Data [Get Countries with Regions](https://docs.leadfeeder.com/api/public/get-countries-with-regions-4477699e0.md): Returns the full list of countries with their administrative regions. - Reference Data [Get Geo Suggestions](https://docs.leadfeeder.com/api/public/get-geo-suggestions-4477698e0.md): Resolves a typed city name or postal code into geographic coordinates. The returned `latitude` / `longitude` can be used to populate the `value.lat` / `value.lon` of the Geo Filter (`field: geo`, `operator: within`). Results can be scoped to one or more countries via `country_codes`, and `search_fields` limits which address fields the text may match; when omitted, both cities and postal codes are searched. - Reference Data [Get Industries](https://docs.leadfeeder.com/api/public/get-industries-4501316e0.md): Returns the full list of industries based on the provided industry classification. - CRM [Create Connect CRM Record Job](https://docs.leadfeeder.com/api/public/create-connect-crm-record-job-4570665e0.md): Trigger an asynchronous job that connects a Leadfeeder company or contact to an existing record in the account's primary CRM. `remote_type` is required (no connection record exists yet to infer it from). The job runs in the background; poll `GET /v1/connect-crm-record-jobs/{job_id}` and, once it completes, fetch the connected record via the matching `GET /v1/crm-organizations/{id}`, `GET /v1/crm-leads/{id}` or `GET /v1/crm-contacts/{id}` endpoint using `result.crm_record.id`. - CRM [Get Connect CRM Record Job](https://docs.leadfeeder.com/api/public/get-connect-crm-record-job-4570666e0.md): Retrieve the status of a job created via `POST /v1/connect-crm-record-jobs`. While `status` is `running`, `result` is omitted. Once `status` becomes `completed`, `result` references the affected CRM record and connection. On `failed`, `errors` describes the failure. Jobs are retained for 3 days after creation. - CRM [Create CRM Contact Job](https://docs.leadfeeder.com/api/public/create-crm-contact-job-4570667e0.md): Trigger an asynchronous job that creates a CRM Contact record in the account's primary CRM from a Leadfeeder contact, and connects the contact to it. Field mappings configured for the integration are respected. The job runs in the background; poll `GET /v1/create-crm-contact-jobs/{job_id}` and, once it completes, fetch the created record via `GET /v1/crm-contacts/{id}` using `result.crm_record.id`. - CRM [Get CRM Contact Job](https://docs.leadfeeder.com/api/public/get-crm-contact-job-4570668e0.md): Retrieve the status of a job created via `POST /v1/create-crm-contact-jobs`. While `status` is `running`, `result` is omitted. Once `status` becomes `completed`, `result` references the affected CRM record and connection. On `failed`, `errors` describes the failure. Jobs are retained for 3 days after creation. - CRM [Create CRM Lead Job](https://docs.leadfeeder.com/api/public/create-crm-lead-job-4570669e0.md): Trigger an asynchronous job that creates a CRM Lead record in the account's primary CRM from a Leadfeeder company **or** contact, depending on what the target CRM supports for Lead creation, and connects it. Provide exactly one of `company_id` or `contact_id`. Field mappings configured for the integration are respected. The job runs in the background; poll `GET /v1/create-crm-lead-jobs/{job_id}` and, once it completes, fetch the created record via `GET /v1/crm-leads/{id}` using `result.crm_record.id`. - CRM [Get CRM Lead Job](https://docs.leadfeeder.com/api/public/get-crm-lead-job-4570670e0.md): Retrieve the status of a job created via `POST /v1/create-crm-lead-jobs`. While `status` is `running`, `result` is omitted. Once `status` becomes `completed`, `result` references the affected CRM record and connection. On `failed`, `errors` describes the failure. Jobs are retained for 3 days after creation. - CRM [Create CRM Organization Job](https://docs.leadfeeder.com/api/public/create-crm-organization-job-4570671e0.md): Trigger an asynchronous job that creates a CRM Organization record in the account's primary CRM from a Leadfeeder company, and connects the company to it. Applicable to CRMs that support the Organization/Account object type. Field mappings configured for the integration are respected. The job runs in the background; poll `GET /v1/create-crm-organization-jobs/{job_id}` and, once it completes, fetch the created record via `GET /v1/crm-organizations/{id}` using `result.crm_record.id`. - CRM [Get CRM Organization Job](https://docs.leadfeeder.com/api/public/get-crm-organization-job-4570672e0.md): Retrieve the status of a job created via `POST /v1/create-crm-organization-jobs`. While `status` is `running`, `result` is omitted. Once `status` becomes `completed`, `result` references the affected CRM record and connection. On `failed`, `errors` describes the failure. Jobs are retained for 3 days after creation. - CRM [Update CRM Connection](https://docs.leadfeeder.com/api/public/update-crm-connection-4570673e0.md): Update the `primary` (data-exchange) and/or `send_visits` flags on a confirmed CRM connection. Applies a partial (merge-patch) update: only the flags named in the request are changed; any flag you omit is left untouched. Setting `primary: true` demotes the company's current primary connection in the same operation. `send_visits` cannot be toggled on contact connections. Suggestions cannot be updated. - CRM [Get CRM Contact](https://docs.leadfeeder.com/api/public/get-crm-contact-4570674e0.md): Retrieve a CRM Contact record mirrored from the account's primary CRM by its Leadfeeder id, e.g. the `result.crm_record.id` returned by a completed CRM job. - CRM [Get CRM Lead](https://docs.leadfeeder.com/api/public/get-crm-lead-4570675e0.md): Retrieve a CRM Lead record mirrored from the account's primary CRM by its Leadfeeder id, e.g. the `result.crm_record.id` returned by a completed CRM job. - CRM [Get CRM Organization](https://docs.leadfeeder.com/api/public/get-crm-organization-4570676e0.md): Retrieve a CRM Organization record mirrored from the account's primary CRM by its Leadfeeder id, e.g. the `result.crm_record.id` returned by a completed CRM job. - CRM [List CRM Users](https://docs.leadfeeder.com/api/public/list-crm-users-4570677e0.md): List the users of the account's primary CRM, e.g. to pick a `crm_owner_id` for a CRM create job. Each CRM user links to the Leadfeeder user it maps to, if any. Results are cursor-paginated. Returns an empty list when the account has no CRM connected. - CRM [Create Disconnect CRM Record Job](https://docs.leadfeeder.com/api/public/create-disconnect-crm-record-job-4570678e0.md): Trigger an asynchronous job that disconnects a confirmed CRM connection, soft-downgrading it to a suggestion. The `remote_type` is inferred from the connection record; the CRM record and the resulting suggestion survive. The job runs in the background; poll `GET /v1/disconnect-crm-record-jobs/{job_id}` to check its status. - CRM [Get Disconnect CRM Record Job](https://docs.leadfeeder.com/api/public/get-disconnect-crm-record-job-4570679e0.md): Retrieve the status of a job created via `POST /v1/disconnect-crm-record-jobs`. On `failed`, `errors` describes the failure. Jobs are retained for 3 days after creation. - CRM [Create Enrich CRM Record Job](https://docs.leadfeeder.com/api/public/create-enrich-crm-record-job-4570680e0.md): Trigger an asynchronous job that enriches the CRM record behind a connection. Only the **primary** (data-exchange) connection can be enriched; targeting a non-primary connection returns `422`. The `remote_type` is inferred from the connection record. Check `enrichment_available` on the connection before calling. The job runs in the background; poll `GET /v1/enrich-crm-record-jobs/{job_id}` and, once it completes, fetch the enriched record via the matching CRM record endpoint using `result.crm_record.id`. - CRM [Get Enrich CRM Record Job](https://docs.leadfeeder.com/api/public/get-enrich-crm-record-job-4570681e0.md): Retrieve the status of a job created via `POST /v1/enrich-crm-record-jobs`. While `status` is `running`, `result` is omitted. Once `status` becomes `completed`, `result` references the affected CRM record and connection. On `failed`, `errors` describes the failure. Jobs are retained for 3 days after creation. - Subscriptions [Create a Purchase Link](https://docs.leadfeeder.com/api/public/create-a-purchase-link-4583172e0.md): Create a link to the account's purchase page in the Leadfeeder app, with the product, tier, billing option and payment method the user chose preselected. The purchase itself is made in the app, not through the API, by a user who can manage billing on the account. Every preselection is optional, and a request without a body creates a plain link. - Subscriptions [Get Purchase Options](https://docs.leadfeeder.com/api/public/get-purchase-options-4583173e0.md): Retrieve what the account can buy in the Leadfeeder app if it starts a new subscription now: the products, how each can be billed, the tiers and their prices, and the product to recommend. The purchase itself is made in the app, not through the API. A product with a `disallow_reason` can't be bought. When the account can't buy any product, `disallow_reason` says why and `products` is empty. ## Schemas - [AccountCompanyV1](https://docs.leadfeeder.com/api/public/accountcompanyv1-945442d0.md): - [AccountSummaryV1](https://docs.leadfeeder.com/api/public/accountsummaryv1-696664d0.md): - [AccountV1](https://docs.leadfeeder.com/api/public/accountv1-696663d0.md): - [ApiUsageV1](https://docs.leadfeeder.com/api/public/apiusagev1-696674d0.md): - [BatchAddTagsJobV1](https://docs.leadfeeder.com/api/public/batchaddtagsjobv1-977837d0.md): - [BatchAddToListJobV1](https://docs.leadfeeder.com/api/public/batchaddtolistjobv1-937594d0.md): - [BatchRemoveFromListJobV1](https://docs.leadfeeder.com/api/public/batchremovefromlistjobv1-937595d0.md): - [BatchRemoveTagsJobV1](https://docs.leadfeeder.com/api/public/batchremovetagsjobv1-977838d0.md): - [BuyerPersonaRequestV1](https://docs.leadfeeder.com/api/public/buyerpersonarequestv1-960421d0.md): - [BuyerPersonaV1](https://docs.leadfeeder.com/api/public/buyerpersonav1-795337d0.md): - [CRMConnectionV1](https://docs.leadfeeder.com/api/public/crmconnectionv1-784905d0.md): - [CRMContactV1](https://docs.leadfeeder.com/api/public/crmcontactv1-784903d0.md): - [CRMLeadV1](https://docs.leadfeeder.com/api/public/crmleadv1-784904d0.md): - [CRMOrganizationV1](https://docs.leadfeeder.com/api/public/crmorganizationv1-784902d0.md): - [CRMUserV1](https://docs.leadfeeder.com/api/public/crmuserv1-784901d0.md): - [CampaignLocationV1](https://docs.leadfeeder.com/api/public/campaignlocationv1-862918d0.md): - [CampaignSettingsV1](https://docs.leadfeeder.com/api/public/campaignsettingsv1-862916d0.md): - [CampaignStatsV1](https://docs.leadfeeder.com/api/public/campaignstatsv1-862920d0.md): - [CampaignSummaryV1](https://docs.leadfeeder.com/api/public/campaignsummaryv1-862917d0.md): - [CampaignV1](https://docs.leadfeeder.com/api/public/campaignv1-862919d0.md): - [CompaniesAdvancedSearchFilterItem](https://docs.leadfeeder.com/api/public/companiesadvancedsearchfilteritem-939460d0.md): - [CompanyFinancialsV1](https://docs.leadfeeder.com/api/public/companyfinancialsv1-696667d0.md): - [CompanyIndustryV1](https://docs.leadfeeder.com/api/public/companyindustryv1-986784d0.md): - [CompanyIpV1](https://docs.leadfeeder.com/api/public/companyipv1-802958d0.md): - [CompanyMatchV1](https://docs.leadfeeder.com/api/public/companymatchv1-696670d0.md): - [CompanyLocationV1](https://docs.leadfeeder.com/api/public/companylocationv1-776960d0.md): - [CompanySummaryV1](https://docs.leadfeeder.com/api/public/companysummaryv1-696669d0.md): - [CompanyV1](https://docs.leadfeeder.com/api/public/companyv1-696666d0.md): - [ContactFilterGroupsV1](https://docs.leadfeeder.com/api/public/contactfiltergroupsv1-977052d0.md): - [ConnectedListV1](https://docs.leadfeeder.com/api/public/connectedlistv1-991211d0.md): - [ConnectCRMRecordJobV1](https://docs.leadfeeder.com/api/public/connectcrmrecordjobv1-1034416d0.md): - [ContactV1](https://docs.leadfeeder.com/api/public/contactv1-696671d0.md): - [CookieConsentSettingsV1](https://docs.leadfeeder.com/api/public/cookieconsentsettingsv1-979019d0.md): - [ContactPreviewV1](https://docs.leadfeeder.com/api/public/contactpreviewv1-1030253d0.md): - [ContactSummaryV1](https://docs.leadfeeder.com/api/public/contactsummaryv1-696672d0.md): - [CountryV1](https://docs.leadfeeder.com/api/public/countryv1-977839d0.md): - [CustomFeedFolderV1](https://docs.leadfeeder.com/api/public/customfeedfolderv1-776958d0.md): - [CustomFieldV1](https://docs.leadfeeder.com/api/public/customfieldv1-720503d0.md): - [CreateCRMContactJobV1](https://docs.leadfeeder.com/api/public/createcrmcontactjobv1-1034417d0.md): - [DataProcessingSettingsV1](https://docs.leadfeeder.com/api/public/dataprocessingsettingsv1-979018d0.md): - [CreateCRMLeadJobV1](https://docs.leadfeeder.com/api/public/createcrmleadjobv1-1034418d0.md): - [EnrichedIpV1](https://docs.leadfeeder.com/api/public/enrichedipv1-696673d0.md): - [CreateCRMOrganizationJobV1](https://docs.leadfeeder.com/api/public/createcrmorganizationjobv1-1034419d0.md): - [ErrorObjectV1](https://docs.leadfeeder.com/api/public/errorobjectv1-696665d0.md): - [CustomFeedRequestV1](https://docs.leadfeeder.com/api/public/customfeedrequestv1-792255d0.md): - [GeoSuggestionV1](https://docs.leadfeeder.com/api/public/geosuggestionv1-977836d0.md): - [CustomFeedV1](https://docs.leadfeeder.com/api/public/customfeedv1-776957d0.md): - [IpAddressExtendedV1](https://docs.leadfeeder.com/api/public/ipaddressextendedv1-802957d0.md): - [DisconnectCRMRecordJobV1](https://docs.leadfeeder.com/api/public/disconnectcrmrecordjobv1-1034420d0.md): - [CRMSuggestionV1](https://docs.leadfeeder.com/api/public/crmsuggestionv1-784906d0.md): - [GoalCreateRequestV1](https://docs.leadfeeder.com/api/public/goalcreaterequestv1-1024799d0.md): - [EnrichCRMRecordJobV1](https://docs.leadfeeder.com/api/public/enrichcrmrecordjobv1-1034421d0.md): - [IpLocationV1](https://docs.leadfeeder.com/api/public/iplocationv1-792804d0.md): - [GoalUpdateRequestV1](https://docs.leadfeeder.com/api/public/goalupdaterequestv1-1024800d0.md): - [CRMGroupConnectionV1](https://docs.leadfeeder.com/api/public/crmgroupconnectionv1-784907d0.md): - [EnrichmentJobV1](https://docs.leadfeeder.com/api/public/enrichmentjobv1-844441d0.md): - [LocationV1](https://docs.leadfeeder.com/api/public/locationv1-776956d0.md): - [MaskedCompanySummaryV1](https://docs.leadfeeder.com/api/public/maskedcompanysummaryv1-734031d0.md): - [FindContactDataJobV1](https://docs.leadfeeder.com/api/public/findcontactdatajobv1-844442d0.md): - [IcpRequestV1](https://docs.leadfeeder.com/api/public/icprequestv1-960420d0.md): - [NetworkV1](https://docs.leadfeeder.com/api/public/networkv1-738428d0.md): - [MaskedContactSummaryV1](https://docs.leadfeeder.com/api/public/maskedcontactsummaryv1-758487d0.md): - [UserV1](https://docs.leadfeeder.com/api/public/userv1-892605d0.md): - [GoalV1](https://docs.leadfeeder.com/api/public/goalv1-1024801d0.md): - [TagV1](https://docs.leadfeeder.com/api/public/tagv1-715311d0.md): - [VisitLocationV1](https://docs.leadfeeder.com/api/public/visitlocationv1-792160d0.md): - [ICPV1](https://docs.leadfeeder.com/api/public/icpv1-830060d0.md): - [WebVisitsTrackerScriptV1](https://docs.leadfeeder.com/api/public/webvisitstrackerscriptv1-776959d0.md): - [ListV1](https://docs.leadfeeder.com/api/public/listv1-715701d0.md): - [SignalV1](https://docs.leadfeeder.com/api/public/signalv1-696668d0.md): - [PurchaseLinkV1](https://docs.leadfeeder.com/api/public/purchaselinkv1-1038127d0.md): - [SubscriptionV1](https://docs.leadfeeder.com/api/public/subscriptionv1-1038102d0.md): - [PurchaseOptionsV1](https://docs.leadfeeder.com/api/public/purchaseoptionsv1-1038128d0.md): - [WebVisitV1](https://docs.leadfeeder.com/api/public/webvisitv1-771265d0.md):