# LeadSquared

> LeadSquared is a marketing automation and CRM platform for capturing, managing, nurturing and converting leads across sales, marketing and service workflows. The LeadSquared REST API (v2) exposes leads, opportunities, activities, tasks, accounts, users, tickets, lists, products, email campaigns and telephony, authenticated with an `accessKey` + `secretKey` pair issued per admin user. There is no OAuth. The API host is region-specific — using the wrong regional host returns 401.

This file was GENERATED by API Evangelist from https://github.com/api-evangelist/leadsquared (apis.yml + the artifacts in that repo) on 2026-08-13. LeadSquared publishes its own `/llms.txt` at https://www.leadsquared.com/llms.txt; it is a 250KB index of marketing and blog pages and contains no reference to apidocs.leadsquared.com, so it does not help an agent reach the API. It is saved verbatim here as `leadsquared-site-llms.txt`.

## APIs

- [LeadSquared REST API](https://apidocs.leadsquared.com/overview/): Leads, opportunities, activities, tasks, accounts, users, tickets, lists, products, email, telephony, Lapps, Batch Jobs, Webhooks and the Mavis Database. Base `https://api.leadsquared.com/v2` (Singapore) — see the regional host list below.
- [LeadSquared Async API](https://apidocs.leadsquared.com/async-api/): Queued, retrying (up to 10 attempts) variants of Capture Lead, Update Lead, Post Activity, Create Lead & Activity, Capture Opportunity, Update Opportunity and Post Call Log. Returns a `RequestId`; poll the matching status endpoint. Base `https://asyncapi.leadsquared.com/`.
- [LeadSquared Portal API](https://apidocs.leadsquared.com/portal-api/): Self-service portal registration, sign-in, OTP sign-in, password reset and auto-login token generation.
- [LeadSquared Service CRM / Tickets API](https://apidocs.leadsquared.com/service-crm/): Ticket create/update/delete, conversations, attachments, advanced search.

## Docs

- [API Overview](https://apidocs.leadsquared.com/overview/)
- [Getting Started](https://apidocs.leadsquared.com/getting-started/)
- [Authentication](https://apidocs.leadsquared.com/authentication/): `accessKey` + `secretKey`, in query string or as `x-LSQ-AccessKey` / `x-LSQ-SecretKey` headers (headers recommended). HTTPS only.
- [API Host (regions)](https://apidocs.leadsquared.com/api-host/): `api.leadsquared.com` (SGP), `api-us11`, `api-in21` (Mumbai), `api-in22` (Hyderabad), `api-me61`, `api-ir31`, `api-ca12` — all `.leadsquared.com/v2/`.
- [Rate Limits](https://apidocs.leadsquared.com/rate-limits/)
- [Error Handling](https://apidocs.leadsquared.com/error-handling/): envelope is `{"Status":"Error","ExceptionType":"…","ExceptionMessage":"…"}`.
- [Webhooks](https://apidocs.leadsquared.com/webhooks/): 33 event types across leads, activities, opportunities, accounts, tasks, products, users and leave.
- [Webhook Best Practices](https://apidocs.leadsquared.com/webhook-best-practices/)
- [Lapps (LeadSquared Apps)](https://apidocs.leadsquared.com/lapps/): serverless Node.js functions that run inside LeadSquared and expose their own REST URL.
- [Mavis Database](https://apidocs.leadsquared.com/mavis-database/)
- [Batch Jobs](https://apidocs.leadsquared.com/batch-jobs/)
- [Marketplace Development Portal](https://apidocs.leadsquared.com/marketplace-development-portal/)
- [Run in Postman](https://apidocs.leadsquared.com/leadsquared-run-in-postman/) — public workspace https://www.postman.com/leadsquaredapi
- [API changelog](https://apidocs.leadsquared.com/news/)

## Conventions

- Versioning: URI path, `/v2`. No version header, no dated versions.
- Pagination: request body objects `Paging {PageIndex, PageSize}` (PageSize max 5000), `Sorting {ColumnName, Direction}` ("1" newest first, "0" oldest first) and `Columns {Include_CSV}`; responses carry `RecordCount` plus the entity array.
- Idempotency: **no** idempotency key. Duplicate prevention is done with upsert-style operations (`Lead.CreateOrUpdate`, `Lead.Capture` with `SearchBy`), not with a client-supplied key.
- Rate limits: plan-based, no `RateLimit-*` / `Retry-After` response headers documented. Pro 10,000 calls/day (+1,000/user/day, cap 250,000) with 10 calls/5s standard and 5 calls/5s bulk; Super 100,000 calls/day (+1,000/user/day, cap 1,000,000) with 20 calls/5s standard and 10 calls/5s bulk.
- Errors: 200 / 400 / 401 / 404 / 500 with the `Status`/`ExceptionType`/`ExceptionMessage` envelope. Not RFC 9457.
- Tracing: the Async API returns a `RequestId` used to poll status; it also requires an `x-api-key` header in addition to the key pair.

## Operations

- [Create a Lead](https://apidocs.leadsquared.com/create-a-lead/) — `POST /LeadManagement.svc/Lead.Create` (`createLead`)
- [Get Lead by Id](https://apidocs.leadsquared.com/get-lead-by-id/) — `GET /LeadManagement.svc/Leads.GetById` (`getLeadById`)
- [Quick Search](https://apidocs.leadsquared.com/quick-search/) — `GET /LeadManagement.svc/Leads.GetByQuickSearch` (`quickSearchLeads`)
- [Post an Activity on a Lead](https://apidocs.leadsquared.com/post-an-activity-to-lead/) — `POST /ProspectActivity.svc/Create` (`postActivity`)

## Specs & artifacts (API Evangelist)

- [OpenAPI — Leads](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/openapi/leadsquared-leads-api-openapi.yml)
- [OpenAPI — Activities](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/openapi/leadsquared-activities-api-openapi.yml)
- [Authentication profile](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/authentication/leadsquared-authentication.yml)
- [Conventions](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/conventions/leadsquared-conventions.yml)
- [Error catalog](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/errors/leadsquared-problem-types.yml)
- [Rate limits](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/rate-limits/leadsquared-rate-limits.yml)
- [Plans & pricing](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/plans/leadsquared-plans-pricing.yml)
- [Webhook catalog](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/asyncapi/leadsquared-webhooks.yml)
- [Data model](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/data-model/leadsquared-data-model.yml)
- [Lifecycle](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/lifecycle/leadsquared-lifecycle.yml)
- [Agent skills](https://raw.githubusercontent.com/api-evangelist/leadsquared/refs/heads/main/skills/_index.yml)

## Not available

- No OAuth 2.0, no OpenID Connect, no scopes.
- No published OpenAPI, Swagger, GraphQL, AsyncAPI or gRPC contract of LeadSquared's own — the two OpenAPI files above were authored by API Evangelist from the documentation.
- No `/.well-known/` documents on any LeadSquared host.
- No A2A agent card.
- No official MCP server.