Skip to main content

How to Use the Online API Documentation

A
Written by Anna-Maria Samuelsson
Updated today

Our online documentation is designed to be interactive, allowing you to explore endpoints, view real-time examples, and even test requests directly from your browser.

You can access the official technical reference for the Leadfeeder API at https://docs.leadfeeder.com/api/public.

Navigating the Documentation

The documentation is organized into a three-column layout to give you the best overview of our services:

  • Left Sidebar: Browse through the available endpoints, grouped by category (e.g., Companies, Contacts, Web Visits, Lists, etc.).

  • Middle Column: View detailed descriptions of each endpoint, including required parameters, headers, and data types.

  • Right Sidebar: See live request and response examples in various programming languages.

Interactive Features

To help you get started quickly, the documentation includes several interactive tools:

  • Try-it-out Functionality: You can execute real API calls directly from the documentation page to see exactly what data is returned.

  • Code Snippets: Automatically generate code for your requests in languages like Python, JavaScript, Ruby, and more.

  • Response: View the exact JSON schema for every response to ensure your application handles the data correctly.

Authentication in the Docs

To use the Try it out feature, you must first fill in your credentials and parameters:

  • Enter your API key: In the Credentials section, enter your valid API token in the X-Api-Key field.

  • Provide your Path Parameters: Some endpoints require path parameters, such as an id. Enter the relevant value in the Path Params section.

Did this answer your question?