Authentication

All requests to the Leadfeeder API must be authenticated.

Getting your API key

To generate an API key:

Navigate to Settings ⚙ → Personal → API Keys

Create a new API key

Note: If you do not see the API keys section, your user may not have the required permissions.
Please contact your account administrator to grant access.

API Key Authentication

Each Leadfeeder user can generate their own API keys.

A valid API key must be included in every request using the X-Api-Key header.

Example

Accounts and Permissions

With a valid API key, you can access all Leadfeeder accounts your user has permissions for.

Most endpoints require an account_id parameter to specify which account’s data should be retrieved.

To find available accounts, call the /accounts endpoint and use the id from the desired account.

Example

Error Handling

If the API key is missing or invalid, the API will return a 403 Forbidden error.

Missing API Key

{
  "code": "missing_token",
  "message": "You need to pass a header named `X-Api-Key` that contains a valid API key."
}

Invalid API Key

{
  "code": "invalid_api_key",
  "message": "The provided API key is invalid. Please generate a new API key."
}

Getting your API key#

API Key Authentication#

Accounts and Permissions#

Error Handling#