Skip to main content

Kanbox API

The Kanbox API allows you to programmatically interact with your Kanbox workspace to add leads, update contacts, and connect Kanbox with your own tools and workflows.

Updated today

It is designed for users who want to automate data flows between Kanbox and external systems such as internal CRMs, forms, enrichment tools, or custom applications.

For the full list of endpoints, request formats, and response schemas, please refer to the Swagger documentation:
https://api.kanbox.io/docs#/

API Availability

The Kanbox API is available only for users with a PRO subscription.

If your account is not on a PRO plan, the API section and API key access will not be available.


Where to Find Your API Key

You can generate and manage your API key directly from your Kanbox account.

Steps:

  1. Open Settings

  2. Go to API

  3. Enable the API key

  4. Copy your key

This key is required to authenticate all requests made to the Kanbox API.


Authentication

The Kanbox API uses static header authentication.

This means that each API request must include your API key in the request headers so Kanbox can identify and authorize your account.

Principle

  • The API key is unique to your workspace

  • It remains the same until regenerated

  • It must be sent with every request

Example

X-API-Key: Bearer YOUR_API_KEY

You should store this key securely and never expose it in frontend code or public repositories.


Kanbox Data Model: Leads vs Members

When using the API, it is important to understand the difference between a lead and a member in Kanbox.

Lead

A lead is a scraped LinkedIn profile imported into Kanbox.

Leads are stored in the Leads section of the platform. At this stage, they are simply potential prospects collected from LinkedIn and not yet attached to your active communication environment.

Member

A member is a lead that has become linked to the user’s workspace activity.

This happens when the lead is added to areas such as:

  • Inbox

  • Pipelines

  • Campaigns

In other words, a member is a lead that is now associated with your Kanbox operations and can be tracked through your outreach and conversation workflows.

Summary

  • Lead = imported LinkedIn user profile

  • Member = lead linked to the user through Kanbox activity

This distinction is useful when deciding how to structure imports and how to use Kanbox entities in your integrations.


Main API Capabilities

The Kanbox API covers the main actions needed to connect external systems with Kanbox.

1. Add leads to Kanbox

You can send LinkedIn leads into Kanbox programmatically instead of importing them manually.

This is useful for:

  • feeding Kanbox from your own prospecting tools

  • pushing leads collected from forms or enrichment workflows

  • centralizing lead acquisition from multiple sources

2. Update contacts

The API allows you to update contact data already stored in Kanbox.

This can be used to:

  • enrich records

  • sync external attributes

  • maintain consistent data between Kanbox and another CRM or internal database

3. Build custom integrations

You can use the API to connect Kanbox with your own stack and automate repetitive actions.

Typical use cases include:

  • syncing Kanbox with a CRM

  • creating internal automation workflows

  • pushing data from third-party tools into Kanbox

  • keeping prospect data aligned across systems


Typical Use Cases

Here are some common ways teams use the Kanbox API:

  • Import leads collected outside Kanbox

  • Sync Kanbox data with a CRM

  • Update prospect records from enrichment tools

  • Automate lead ingestion from forms, scraping tools, or internal systems

  • Build custom workflows around prospect management


Best Practices

To use the API securely and reliably:

  • Keep your API key private

  • Do not expose the key in client-side applications

  • Use server-side requests whenever possible

  • Review the Swagger documentation before implementation

  • Make sure you understand whether your workflow should create or update a lead or interact with a member


API Reference

For complete technical details, including:

  • available routes

  • request parameters

  • request body formats

  • authentication requirements

  • response schemas

please use the official Swagger documentation:

Did this answer your question?