LeadPanther API

LeadPanther API Reference

The canonical API reference source is:

docs/api/openapi.yaml

It is an OpenAPI 3.1 document for the current API v1 surface at:

https://app.leadpanther.ai/api/v1

Do not duplicate /api/v1 when building URLs from the OpenAPI document. The servers[0].url already includes /api/v1, so the OpenAPI path /posts resolves to:

https://app.leadpanther.ai/api/v1/posts

Current Coverage

The reference covers:

  • API metadata and authenticated subject inspection.
  • Direct-user and agency-client client routes.
  • Posts, including lead magnet post creation through template_id.
  • Lead magnets, including hosted, gated external, and external link modes.
  • Media upload URL creation and media deletion.
  • Post engagement and lead magnet analytics.
  • Leads and inbound activity.

Each operation includes:

  • operationId
  • required scope metadata in x-required-scopes
  • request parameters and request body schema where applicable
  • success response schema
  • common error response schemas

Sensitive Data

The OpenAPI file uses placeholder examples only. Do not add real API keys, real customer names, real emails, production UUIDs, key hashes, platform IDs, message text, or privileged backend data.

The leads:read and activity:read endpoints can return personal data and message/comment content. Rendered docs should keep those privacy warnings visible near the relevant endpoints.

Renderer Plan

This file is portable and can feed:

  • an in-house docs app at docs.leadpanther.ai
  • Scalar
  • Mintlify
  • Fern
  • ReadMe
  • Redocly

Phase 3 should choose the hosted docs renderer and wire this OpenAPI file into the public docs site.

Validation

Validate the source with:

npx --yes @redocly/cli@latest lint docs/api/openapi.yaml

As of Phase 2, the only expected warning is that GET / does not list a 4XX response. That endpoint is intentionally unauthenticated API metadata and does not currently have a meaningful public 4xx response contract.