# LeadBoxer Platform Documentation

> Documentation for LeadBoxer Platform

## Guides: Overview
- [What is the LeadBoxer Platform?](https://developers.leadboxer.com/docs/what-is-the-leadboxer-platform.md)
- [How the Platform Works](https://developers.leadboxer.com/docs/products-apis-overview.md)
- [Choose Your Integration Path](https://developers.leadboxer.com/docs/choose-your-integration-path.md)

## Guides: Getting Started
- [Quickstart Guide](https://developers.leadboxer.com/docs/quickstart.md)
- [Authentication & API Keys](https://developers.leadboxer.com/docs/authentication-api-keys.md): The LeadBoxer API uses API key authentication to secure access to endpoints. All API requests must include a valid API key to authenticate.
- [Rate Limiting](https://developers.leadboxer.com/docs/credits-rate-limits.md): To protect the platform and ensure fair usage across clients, API requests are subject to per-minute rate limits. When a client exceeds the limit for an endpoint, further requests to that endpoint…
- [Responses](https://developers.leadboxer.com/docs/responses.md)
- [Validation Failed](https://developers.leadboxer.com/docs/validation-error.md): A validation error occurs when your request is syntactically correct but contains invalid data, missing required fields, or improperly formatted values.
- [Rate Limit Exceeded](https://developers.leadboxer.com/docs/rate-limit-exceeded.md): Occurs when the client exceeds the allowed number of API requests per time window.
- [Authentication Failed](https://developers.leadboxer.com/docs/authentication-failed.md): Occurs when the request contains invalid or missing authentication credentials.
- [Resource Not Found](https://developers.leadboxer.com/docs/resource-not-found.md): Occurs when the requested resource does not exist.
- [Payment Required](https://developers.leadboxer.com/docs/payment-required.md): Occurs when the user tries to access a feature requiring payment or subscription.
- [Access Denied](https://developers.leadboxer.com/docs/access-denied.md): The request was valid, but you do not have permission to access the requested resource.  This error occurs when the resource exists but you **lack sufficient permissions** to access it.
- [Resource already exist](https://developers.leadboxer.com/docs/resource-already-exist.md): Occurs when attempting to create a resource that already exists.
- [Internal Server Error](https://developers.leadboxer.com/docs/internal-server-error.md): Occurs when an unexpected error happens while processing the request.
- [Credit Usage & Cost Model](https://developers.leadboxer.com/docs/credit-usage-cost-model.md)

## Guides: Core Concepts
- [LeadBoxer Platform introduction](https://developers.leadboxer.com/docs/leadboxer-api-introduction.md)
- [Events](https://developers.leadboxer.com/docs/events.md)
- [Users, Sessions, Identities & Stitching](https://developers.leadboxer.com/docs/identities-stitching.md)
- [Leads & Accounts](https://developers.leadboxer.com/docs/leads-accounts.md)

## Guides: Implementation Guides
- [JavaScript for Website Tracking](https://developers.leadboxer.com/docs/javascript-sdk.md)
- [Email Tracking](https://developers.leadboxer.com/docs/email-tracking.md)
- [Server-Side Event Tracking](https://developers.leadboxer.com/docs/server-side-events.md): Backend Log API Guide
- [Using the App API to Fetch Leads](https://developers.leadboxer.com/docs/using-the-app-api-to-fetch-leads.md)
- [IP / Company Lookup ](https://developers.leadboxer.com/docs/ip-email-company-lookup.md)
- [When to use which API](https://developers.leadboxer.com/docs/when-to-use-which-api.md)
- [White-Labeling the Tracking Script](https://developers.leadboxer.com/docs/white-labeling-the-leadboxer-tracking-script-with-cloudflare.md): Serve the LeadBoxer tracking script from your own domain using Cloudflare Workers. This hides the LeadBoxer origin from visitors and reduces the chance of the script being blocked by ad blockers or…

## Guides: RESPONSES
- [Lead Object](https://developers.leadboxer.com/docs/lead-object.md)

## Guides: Integrations
- [n8n](https://developers.leadboxer.com/docs/n8n.md)
- [Make](https://developers.leadboxer.com/docs/make.md)

## Guides: MCP Server
- [Connect LeadBoxer to Claude](https://developers.leadboxer.com/docs/connect-leadboxer-to-claude.md): Use LeadBoxer in Claude and Claude Code to find the company behind an IP address and enrich company domains.
- [MCP](https://developers.leadboxer.com/docs/mcp.md)

## API Reference
- [Getting Started](https://developers.leadboxer.com/reference/getting-started.md): Use this page to test and use the LeadBoxer Platform right now in 3 simple steps. You will need a LeadBoxer account to get started. You can create an account here: https://app.leadboxer.com/sign-up
- [Authentication](https://developers.leadboxer.com/reference/authentication.md): The LeadBoxer API uses API key authentication to secure access to endpoints. All API requests must include a valid API key to authenticate.

## API Reference: Leadboxer API
- [IP Address Lookup](https://developers.leadboxer.com/reference/lookupip.md): Retrieve detailed information about an IP address, including organization, geolocation, ISP details, and metadata.  Returned Data When a match is found, the following fields are returned:…
- [Domain Lookup](https://developers.leadboxer.com/reference/lookupdomain.md): Retrieve organization details associated with a domain name. Provide a clean domain name (e.g., leadboxer.com) without protocol or www prefix.  Returned Data When a match is found, the following…
- [Update User Name](https://developers.leadboxer.com/reference/updatename.md): Updates the display name of an existing user.
- [Create or Associate User](https://developers.leadboxer.com/reference/adduser.md): Creates a new user or associates an existing user with an account, depending on the provided data.
- [Resend User Invitation](https://developers.leadboxer.com/reference/resendinvite.md): Resends an invitation email to the specified user.
- [Get User Datasets](https://developers.leadboxer.com/reference/getuserdatasets.md): Returns the list of datasets the authenticated user has access to.
- [Delete User](https://developers.leadboxer.com/reference/removeuser.md): Removes a user from the account and revokes access to all associated resources.
- [Update Lead Tags](https://developers.leadboxer.com/reference/updateleadtags.md): Adds or removes lead tags for a specified lead.
- [Assign Leads](https://developers.leadboxer.com/reference/assignleads.md): Assigns lead to a user.
- [Update Dataset Name](https://developers.leadboxer.com/reference/updatedatasetname.md): Updates the human-readable name of the specified dataset.
- [Update Form Tracking](https://developers.leadboxer.com/reference/updateformtracking.md): Updates the form tracking configuration for the specified dataset, including enabling/disabling tracking, IP masking, and form input attributes.
- [Add Dataset](https://developers.leadboxer.com/reference/adddataset.md): Creates a new dataset in the account and associates it with the specified users.
- [Remove Dataset](https://developers.leadboxer.com/reference/removedataset.md): Deletes the specified dataset from the account.
- [Update Existing Segment](https://developers.leadboxer.com/reference/updatesegment.md): Update an existing segment with the given configuration. Use this endpoint to update filter criteria, email preferences etc.
- [Delete Segment](https://developers.leadboxer.com/reference/deletesegment.md): To delete specified segment.
- [Update Segment User](https://developers.leadboxer.com/reference/updatesegmentuser.md): Updates the user associated with the segment, which allow that user to access the segment.
- [Retrieve Segments for a Given Site](https://developers.leadboxer.com/reference/getsegments.md): Fetches segments associated with a specified dataset and account, for a user identified by email.
- [Create a New Segment](https://developers.leadboxer.com/reference/createsegment.md): Creates a new segmentRequest for the specified account and dataset using the provided configuration. This includes applying filters and setting up any email notification preferences.
- [Get Default Segment Users](https://developers.leadboxer.com/reference/getusersbysegmentidanddatasetid.md): Get the list of User IDs for whom the specified segment is set as the default under the given Dataset ID.
- [Add/Update Default Segment for Users](https://developers.leadboxer.com/reference/savedefaultsegment.md): Sets the given Segment ID as the default segment for the provided list of User IDs under the specified Dataset ID. Users included in the list will have their default segment added or updated…
- [Remove Default Segment](https://developers.leadboxer.com/reference/deletedefaultsegment.md): Remove Default Segment for the user with the given Email under the given Dataset ID.
- [Retrieve Leads](https://developers.leadboxer.com/reference/users.md): Returns a list of leads in JSON format based on the provided filters and query parameters.
- [Retrieve Lead Details](https://developers.leadboxer.com/reference/leaddetail.md): Returns detailed information for a single lead, identified by its lead ID.
- [Retrieve Lead Sessions](https://developers.leadboxer.com/reference/getsessions.md): Returns all sessions associated with a specific lead ID. Results can be filtered by segment and time range.
- [Retrieve Leads (CSV)](https://developers.leadboxer.com/reference/userscsv.md): Exports a filtered list of leads as a CSV file for download.
- [Retrieve Lead Events](https://developers.leadboxer.com/reference/getevents.md): Returns all events associated with a specific session ID. Results can be optionally filtered by segment.
- [Fetch User Datasets](https://developers.leadboxer.com/reference/getuserdatasets_1.md): Retrieves the datasets associated with a user for the given account. This provides details about the user's datasets under their account.
- [Add User Dataset](https://developers.leadboxer.com/reference/adduserdataset.md): Associates a user with a dataset. This operation allows the user to access and work with the specified dataset.
- [Remove User Dataset](https://developers.leadboxer.com/reference/removeuserdataset.md): Disassociates a user from a dataset. This operation will prevent the user from accessing the specified dataset.
- [Update Custom Tracking Domain by Dataset ID](https://developers.leadboxer.com/reference/updatedcustomtrackingdomain.md): Update custom tracking domain entry for the given dataset Id and ctd.
- [Validate Custom Tracking Domain](https://developers.leadboxer.com/reference/validatecustomtrackingdomain.md): Validate the given custom tracking domain.
- [Add Custom Tracking Domain](https://developers.leadboxer.com/reference/addcustomtrackingdomain.md): Adds a custom tracking domain to the dataset and triggers the certificate generation process. <br/><br/><b>Note:</b> This operation may take several minutes to complete.<br/><br/>The response…
- [Get Custom Tracking Domain by Dataset ID](https://developers.leadboxer.com/reference/getcustomtrackingdomains.md): Get all custom tracking domains for a given dataset Id.
- [Delete Custom Tracking Domain by Dataset ID](https://developers.leadboxer.com/reference/deletecustomtrackingdomain.md): Delete custom tracking domain entry for the given dataset Id and ctd.
- [Retrieve leads exclusions](https://developers.leadboxer.com/reference/getdatasetexclusions.md): Use this API to retrieve dataset exclusion rules.
- [Hide leads](https://developers.leadboxer.com/reference/savedatasetexclusion.md): Use this API to define exclusion rules for specific datasets. These rules allow you to hide leads based on different criteria, such as a specific identifier (use_id) or attributes like…
- [Unhide leads](https://developers.leadboxer.com/reference/deletedatasetexclusion.md): Use this API to delete existing dataset exclusion rules.
- [Get Credit Grants](https://developers.leadboxer.com/reference/getavailablecreditgrants.md)

## API Reference: Track API
- [Track Event](https://developers.leadboxer.com/reference/track-event.md)

## API Reference: Email tracking API
- [Track Email Opens](https://developers.leadboxer.com/reference/new-endpoint-1.md)
  - [Track email open event](https://developers.leadboxer.com/reference/track-email-open-event.md): Track Email Opens or Reads with a tracking pixel

## API Reference: LeadBoxer Onboarding API
- [Process user signup](https://developers.leadboxer.com/reference/processusersignup-1.md): Registers a new user.  On success, the API returns: - accountId - userId - datasetId - trialEndDate  The returned accountId should be used in the generate API key endpoint.

## Recipes
- [Create an email tracking pixel](https://developers.leadboxer.com/recipes/create-an-email-tracking-pixel.md)

## Changelog
- [Improved ip-lookup endpoint & credit docs](https://developers.leadboxer.com/changelog/improved-ip-lookup-endpoint-credit-docs.md)
- [Removed dataType parameter from Retrieved Leads](https://developers.leadboxer.com/changelog/removed-datatype-parameter-from-retrieved-leads.md)
- [Added the Track and Email Tracking endpoints](https://developers.leadboxer.com/changelog/added-the-track-and-email-tracking-endpoints.md)
- [New Developers Portal live](https://developers.leadboxer.com/changelog/new-developers-portal-live.md)