Overview
Welcome to LeadSquared API!
All of LeadSquared’s APIs are organized around REST. If you’ve used RESTful APIs before, many of the concepts here will be familiar to you. Each resource has a unique URL, and HTTP verbs are used to specify actions you want to perform on each resource. All request and response bodies, including errors, are encoded in JSON.
Here’s what you can do with our APIs –
- Create, update, delete and retrieve detailed information on LeadSquared resources (Leads, Activities, Tasks, etc.).
- Perform queries or searches.
- Manage email marketing.
- Integrate telephony applications.
- And lots more…
API Version
We release new versions when we make backwards-incompatible changes to our APIs. The current version of our APIs is v2, so the base URL will always look something like this –
https://<your API host>/v2/
HTTP Methods
We support 2 standard HTTP methods – GET and POST.
GET: Used to read/retrieve a resource.
POST: Used to create or update a resource.
In certain cases, we use the GET and POST methods a little differently. For example, we use POST for advanced searches, quick searches etc. The method you need to use is clearly laid out in the API URL section for each API call –
Date and Time Format
The supported DateTime format for all LeadSquared APIs is UTC (YYYY-MM-DD HH:MM:SS). For e.g., the date 26th March, 2016, 02:15 PM will be formatted as “2016-03-26 14:15:00” in UTC. DateTime data passed in any other format may cause errors.
What’s Next?
Read up on our API host documentation.
