Skip to main content
Leadping SDKs provide typed models and route builders generated from the same OpenAPI specification as the API Reference. Use an SDK for applications that read or manage Leadping organization data. For an external system that only submits leads, direct source-key intake is usually simpler; see Send Leads.

​
Packages

​
Before creating a client

Each generated client requires a Microsoft Kiota request adapter supplied by your application. The adapter must:
  • use https://api.leadping.ai as the base URL;
  • attach the correct Bearer credential;
  • serialize requests and parse responses; and
  • integrate with your application’s HTTP, logging, and retry behavior.
The SDK does not manage sign-in, token refresh, key storage, or secret rotation.

​
Authentication

Read API Authentication before creating the request adapter.

​
Client entry points

​
Make the first read useful

Each language guide reads one lead using an organization API key. Set LEADPING_API_KEY in the process environment and replace lead-id with an existing lead ID from that organization. A fabricated ID will not prove that your integration can read a record. The request adapter is the HTTP layer: it attaches authentication and translates between JSON and generated models. Configure its timeout, logging, and retry behavior deliberately. Keep the API host restriction in the authentication provider so a changed destination does not receive your credential.

​
Handle generated models and errors

Optional fields may be absent or null. Check for a response and for the fields your application needs before using them. An empty list is a valid query result; an authentication error is not an empty list and should not be swallowed as one. Use the installed package’s generated request types for writes. Do not copy a response object wholesale into an update: response fields such as IDs, timestamps, and processing state may be read-only or irrelevant to that request. Consult the endpoint’s request schema for required fields and replacement behavior.

​
Upgrade an integration

  1. Keep the current dependency lockfile and SDK version so you can reproduce the deployed client.
  2. Update the SDK and compatible Kiota packages together in a branch.
  3. Review compile or type errors alongside the changed endpoint schemas.
  4. Check one representative read and each write behavior your integration uses, including failures and null optional fields.
  5. Review retry middleware before release, especially for lead creation, messages, calls, and number purchases.
An SDK update does not change a credential’s permissions. If a newly exposed method is rejected, check its authentication requirements instead of changing the generated client.

​
Language guides

TypeScript

Python

.NET

Go

PHP

Java

SDK releases use vX.Y.Z versions. Review package release notes before upgrading and test generated model or route changes before production deployment.