Docs menu

API reference

The API lets your own software work with your NavaPrastha employees. It is a plain JSON API over HTTPS.

Base addresshttps://navaprastha.in/api/v1
FormatJSON in, JSON out. Phone numbers come back as +919848012345. Times are Unix seconds. Amounts are in paise.
Versionv1. Within v1 we only add things. See the changelog.

Quickstart

  1. Sign in to your dashboard, open Developers and create a key. It starts with np_live_. It is shown once, so copy it now.
  2. Check the key. A read-only key works for this.
  3. Ask what a call would do, without calling anyone, using dryRun.
  4. Place a real call or add a lead. Send an Idempotency-Key so a retry never does it twice.
export NAVAPRASTHA_KEY="np_live_..."

# 1. Whose key is this?
curl https://navaprastha.in/api/v1/me -H "Authorization: Bearer $NAVAPRASTHA_KEY"

# 2. What would this call do? Nothing is dialled and nothing is charged.
curl https://navaprastha.in/api/v1/calls \
  -H "Authorization: Bearer $NAVAPRASTHA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone":"98480 12345","consent":true,"dryRun":true}'

# 3. Add a lead
curl https://navaprastha.in/api/v1/leads \
  -H "Authorization: Bearer $NAVAPRASTHA_KEY" \
  -H "Idempotency-Key: lead-1042" \
  -H "Content-Type: application/json" \
  -d '{"name":"Ravi Kumar","phone":"98480 12345","externalId":"crm-1042","consent":true}'

What is in the API

  • Account: Who the key belongs to, the wallet, the numbers and the employees on the account. Every key, including a read-only one, can use these.
  • 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.
  • Calls: A call is one request to call one person from your own number. It follows every rule that calls follow in the dashboard: calling hours, do-not-call, consent and credit.
  • Campaigns: A campaign calls a whole list within the allowed hours and tries again with people who did not pick up. Everyone on it must have agreed to hear from you.
  • Do not call: A number on your do-not-call list is never called by a call, a campaign or the API. People who say "stop calling" on a call are added automatically.
  • Conversations and bookings: Every WhatsApp chat and every phone call is a conversation, and the appointments the employee booked are listed too. This is how your own software reads what the employee did.

Also read Authentication, Testing safely, Errors and limits, Idempotency and pagination and Webhooks.

Downloads

OpenAPI 3.1 file (generate a client in your language, or import it into any API tool) and a Postman collection with every request. Set the collection variable apiKey and send.

Not in the API yet

Sending a WhatsApp message and changing an employee’s settings are done in the dashboard for now. Tell us what you need at bodavulasiddardha@navaprastha.in.

Last updated 13 November 2026. Found something wrong on this page? Email bodavulasiddardha@navaprastha.in and we will correct it.