Overview
The Progz API connects your own systems to your AI employees. Send in leads and candidates from your website, CRM or ads, ask your AI employee to call them, and read back what happened: who qualified, what they said and when they are coming in.
What you can do
- Send in leads and candidates the moment they enquire or apply, with anything they already told you (budget, timeline, experience).
- Have your AI employee call them. It calls within your calling hours, qualifies or screens them by your rules, and books a visit, demo or interview into your calendar.
- Read the results: each person's status, the facts collected on the call, upcoming bookings, and conversation summaries.
- Run campaigns to call a whole list, and keep your contacts in step with your CRM.
Before you start
- A Progz business with an AI employee that has finished setup: a sales employee with an active offering, or a hiring employee with an open job. Leads and candidates belong to one of these.
- An API key. An admin of the business creates it in Settings → API keys; see Authentication.
- Credits in your wallet: calls are charged per started minute, like calls you start from the app.
Base URL
Every request goes to this address, over HTTPS, with JSON in and out:
https://progz.in/api/v1Send Content-Type: application/json with request bodies. Times are ISO 8601 in UTC, ids are UUIDs, and phone numbers come back in international format (+919876543210).
Your first request
Put your key in an environment variable called PROGZ_API_KEY, then list your most recent lead:
curl "https://progz.in/api/v1/leads?limit=1" \
-H "Authorization: Bearer $PROGZ_API_KEY"A working key answers with a page of leads (here, one):
{
"items": [
{
"id": "3f6c2a1e-8b4d-4c1a-9e2f-5d7b8a9c0e11",
"offering_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"offering_name": "3 BHK apartments, Kondapur",
"contact": {
"id": "9e8d7c6b-5a49-4382-9170-6f5e4d3c2b1a",
"full_name": "Ravi Kumar",
"phone": "+919876543210",
"email": "ravi@example.com",
"preferred_language": "te-IN",
"do_not_contact": false,
"whatsapp_opt_in": false
},
"status": "demo_booked",
"facts": { "budget_inr": 6500000, "purchase_timeline_days": 60, "interested": true },
"interest": null,
"notes": "",
"source": "website",
"call_requested_at": null,
"created_at": "2026-10-23T09:14:02.512Z",
"updated_at": "2026-10-23T09:51:18.619Z",
"call_timing": null
}
],
"total": 128,
"limit": 1,
"offset": 0
}A 401 means the key is wrong, revoked or expired. Every error has the same shape; see Errors. Stuck? Try the FAQ.
How a lead flows through
- You create the lead (
POST /leads) with their name, phone and the offering they asked about. See Send in leads. - You ask your AI employee to call (
POST /leads/{id}/request-qualification). Outside your calling hours the call waits for them. If it can't start at all yet (the employee is paused, or the wallet is empty) you get409 call_waiting: the request is kept, and the call starts by itself once that is fixed. - The AI employee calls, asks your qualifying questions, and books a slot if your rules say they fit.
- The lead's
statusmoves on (for examplequalifying→demo_booked), and itsfactsfill in. - You read the lead back, or list upcoming bookings, and update your own system.
Candidates for a job work the same way, with POST /candidates and /candidates/{id}/request-screening. See Hiring.