Skip to main content

The LeadX API

LeadX exposes its entire customer-facing surface over one authenticated REST API. An API key is the credential for machine-to-machine access: it stands in for a member of your company, and it reaches the same endpoints the LeadX web app uses.

That surface is large — 479 endpoints across leads, contacts, campaigns, AI Genie outreach, workflows, unified chat, integrations, analytics and billing. Everything the product does, an API key can drive.

How it fits together​

  your integration
        │
        │  apikey: <your key>
        ▼
  https://api.leadx.in/api/key/protected/...
        │
        ▼
   leadx-api  ──────►  ms-send-manager   (bulk campaign sends)
        │      ──────►  ms-unified-chat   (1:1 replies, Genie outreach)
        │      ──────►  ms-workflow       (automation engine)
        │      ──────►  ms-enrich         (website scraping)
        │      ──────►  ms-import         (bulk CSV import)
        ▼
     MongoDB

You only ever talk to leadx-api. It orchestrates the microservices behind it, so a single key covers imports, sends, enrichment and workflow runs without you addressing those services directly.

Two ways in​

CredentialHeaderUse it for
API keyapikey: <key>Server-to-server integrations, scripts, data sync. This is what these docs cover.
Session JWTAuthorization: Bearer <jwt> + authmember: <memberId>The LeadX web app itself. Enforces the per-role permission matrix.

The two mount the same router at different paths:

  • /api/protected/... — session JWT, runs authorize (role permissions + plan feature gating)
  • /api/key/protected/... — API key, skips authorize

That difference matters, and it is covered in detail under API keys and access scope.

Start here​

  • Quickstart — make your first authenticated call in about two minutes
  • API keys — create, use, and understand the limits of a key
  • Conventions — the response envelope, pagination, filtering and errors that apply to every endpoint
  • Guides — task-shaped walkthroughs for the things people actually build
  • API Reference — every endpoint, grouped by area

:::tip Read the conventions first Almost every list endpoint in LeadX shares one pagination, search and filter contract, and almost every write endpoint shares one bulk contract. Learning those once means the other 470-odd endpoints need no further explanation. :::