Docs menu

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

phone
text
Only this number.
externalId
text
Only the lead with your own reference.
status
text
new, contacted, qualified, booked or lost.
limit
integer
How many items, 1 to 100. Default 50.
cursor
text
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

name
text, required
Up to 100 characters.
phone
text
An Indian mobile number in any usual form (98480 12345, 09848012345, +919848012345).
email
text
Optional.
externalId
text
Your own reference for this person, up to 80 characters.
status
text
new, contacted, qualified, booked or lost.
tags
list
Up to 10 short tags.
notes
text
Up to 2,000 characters.
consent
true or false
True only if this person asked to be contacted or is your customer. Calls need it.
call
object
{ "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.