> ## Documentation Index
> Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Leadping API Reference

> Use Leadping endpoint schemas, examples, authentication guidance, SDKs, and the public OpenAPI specification.

The Leadping REST API provides access to leads, sources, conversations, automations, phone numbers, messages, calls, billing, and operational records.

Endpoint pages in this reference are generated from the Leadping OpenAPI specification and contain current paths, parameters, request bodies, response models, status codes, and examples.

## Before making a request

1. Choose the correct identity and credential in [API Authentication](/docs/api-authentication).
2. Use a source key only for the external lead-ingestion routes.
3. Select direct HTTP or a generated [Leadping SDK](/docs/sdks/overview).
4. Implement status-code handling and [rate-limit](/docs/rate-limits) backoff.
5. Test with controlled data before enabling production traffic.

## Read an endpoint page

Check the HTTP method, path, credential requirements, required fields, and documented success response together. A route’s presence in the reference does not mean every credential can call it. Paths containing `/me` or `/my` use the applicable authenticated context; those names are not values to replace.

Some read operations use `POST` because their query includes a JSON body. For example, `POST /leads/all/my` lists leads, while `POST /leads` creates one. Determine retry safety from the operation’s behavior, not just its method.

## Page through a collection

For a list operation that accepts `RequestDataOptions`, start without a cursor:

```json theme={null}
{
  "pageSize": 25,
  "includeCount": false
}
```

For the next request, copy the returned `continuationToken` into the same query. Keep filters and sorting unchanged while following a cursor. Stop when the response has no continuation token; do not infer completion from a short page or calculate a cursor yourself.

## Separate acceptance from completion

Lead intake, exports, scheduled messages, and automation runs may have later work to complete. Save the returned identifier and read the resource’s status. A lead’s processing status, an automation’s run status, and a message’s delivery status describe different operations.

For errors, inspect the HTTP status and any `application/problem+json` body. Use the status to select an action and the detail to diagnose the specific request; avoid matching the exact wording of a human-readable error in application logic.

## Integration resources

<CardGroup cols={2}>
  <Card title="Developer overview" icon="diagram-project" href="/docs/developers/overview">
    Select an integration path and credential.
  </Card>

  <Card title="Leadping SDKs" icon="code" href="/docs/sdks/overview">
    Use typed clients for TypeScript, Python, .NET, Go, PHP, or Java.
  </Card>

  <Card title="Rate limits" icon="gauge" href="/docs/rate-limits">
    Handle throttling and production retry behavior.
  </Card>

  <Card title="Automation webhooks" icon="shield-check" href="/docs/validating-webhooks">
    Configure automation requests and understand receiver authentication limitations.
  </Card>
</CardGroup>

## OpenAPI specification

Use the public [OpenAPI JSON document](/docs/openapi.json) to generate clients, validate contracts, or connect OpenAPI-compatible tooling.

For source-authenticated lead posting, begin with [Send Leads with the Intake API](/docs/sending-leads-to-leadping). Intake has source-specific authentication, TrustedForm, and validation requirements.