Use the TypeScript SDK

Install the Leadping TypeScript SDK, supply a Kiota request adapter, and call typed API routes.

• Package: @leadping/sdk
• Repository: leadpingai/leadping-typescript

Install

npm install @leadping/sdk @microsoft/kiota-http-fetchlibrary

Create the client

import { createLeadpingOpenApiClient } from "@leadping/sdk";
import { ApiKeyAuthenticationProvider, ApiKeyLocation } from "@microsoft/kiota-abstractions";
import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";

const credential = process.env.LEADPING_API_KEY;
if (!credential) throw new Error("LEADPING_API_KEY is not set.");

const authProvider = new ApiKeyAuthenticationProvider(
  `Bearer ${credential}`,
  "Authorization",
  ApiKeyLocation.Header,
  new Set(["api.leadping.ai"]),
);
const client = createLeadpingOpenApiClient(new FetchRequestAdapter(authProvider));
const lead = await client.leads.byId("lead-id").get();

The client defaults to https://api.leadping.ai. Set LEADPING_API_KEY to an organization API key. client.users.me requires a user access token; source keys are only for lead intake.

The SDK does not store or refresh credentials. See API Authentication.

Call routes

const source = await client.sources.byId("source-id").get();
const lead = await client.leads.byId("lead-id").get();
// Requires a user access token.
const currentUser = await client.users.me.get();

Use generated request-body and model types from @leadping/sdk when creating or updating records. Confirm endpoint contracts in the API Reference, and handle 429 responses using the rate-limit guide.