Leads
A lead is a person in your CRM. If a lead with the same externalId or phone number exists, it is updated, not duplicated.
GET /leads
List leads. Any key, including a read-only key.
Query parameters
phonetext | Only this number. |
|---|---|
externalIdtext | Only the lead with your own reference. |
statustext | new, contacted, qualified, booked or lost. |
limitinteger | How many items, 1 to 100. Default 50. |
cursortext | The nextCursor from the previous page. |
Request
curl https://navaprastha.in/api/v1/leads \
-H "Authorization: Bearer $NAVAPRASTHA_KEY"Response
{
"data": [
{
"id": "9f3c0a1b2c3d4e5f",
"name": "Ravi Kumar",
"phone": "+919848012345",
"email": "",
"source": "api",
"status": "new",
"notes": "",
"tags": [
"vip"
],
"externalId": "crm-1042",
"consent": true,
"dnc": false,
"lastCalledAt": null,
"lastOutcome": "",
"createdAt": 1794135000,
"updatedAt": 1794135000
}
],
"nextCursor": null
}POST /leads
Add or update a lead. Needs a full-access key.
Returns 201 for a new lead and 200 when an existing one was updated. Only the fields you send are changed. Add a call object to place a call to the lead straight away (it needs consent: true).
Request body
nametext, required | Up to 100 characters. |
|---|---|
phonetext | An Indian mobile number in any usual form (98480 12345, 09848012345, +919848012345). |
emailtext | Optional. |
externalIdtext | Your own reference for this person, up to 80 characters. |
statustext | new, contacted, qualified, booked or lost. |
tagslist | Up to 10 short tags. |
notestext | Up to 2,000 characters. |
consenttrue or false | True only if this person asked to be contacted or is your customer. Calls need it. |
callobject | { "purpose": "reminder", "script": "..." } places a call now. |
Request
curl -X POST https://navaprastha.in/api/v1/leads \
-H "Authorization: Bearer $NAVAPRASTHA_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: unique-text-from-your-system" \
-d '{"name":"Ravi Kumar","phone":"98480 12345","externalId":"crm-1042","consent":true,"tags":["vip"]}'Response
{
"data": {
"id": "9f3c0a1b2c3d4e5f",
"name": "Ravi Kumar",
"phone": "+919848012345",
"email": "",
"source": "api",
"status": "new",
"notes": "",
"tags": [
"vip"
],
"externalId": "crm-1042",
"consent": true,
"dnc": false,
"lastCalledAt": null,
"lastOutcome": "",
"createdAt": 1794135000,
"updatedAt": 1794135000
},
"call": null
}GET /leads/{id}
Read one lead. Any key, including a read-only key.
Request
curl https://navaprastha.in/api/v1/leads/ID \
-H "Authorization: Bearer $NAVAPRASTHA_KEY"Response
{
"data": {
"id": "9f3c0a1b2c3d4e5f",
"name": "Ravi Kumar",
"phone": "+919848012345",
"email": "",
"source": "api",
"status": "new",
"notes": "",
"tags": [
"vip"
],
"externalId": "crm-1042",
"consent": true,
"dnc": false,
"lastCalledAt": null,
"lastOutcome": "",
"createdAt": 1794135000,
"updatedAt": 1794135000
}
}PATCH /leads/{id}
Change some fields of a lead. Needs a full-access key.
Request
curl -X PATCH https://navaprastha.in/api/v1/leads/ID \
-H "Authorization: Bearer $NAVAPRASTHA_KEY" \
-H "Content-Type: application/json" \
-d '{"status":"qualified"}'Response
{
"data": {
"id": "9f3c0a1b2c3d4e5f",
"name": "Ravi Kumar",
"phone": "+919848012345",
"email": "",
"source": "api",
"status": "qualified",
"notes": "",
"tags": [
"vip"
],
"externalId": "crm-1042",
"consent": true,
"dnc": false,
"lastCalledAt": null,
"lastOutcome": "",
"createdAt": 1794135000,
"updatedAt": 1794135000
}
}Last updated 13 November 2026. Found something wrong on this page? Email bodavulasiddardha@navaprastha.in and we will correct it.