Skip to main content

Developers

Search the API

Overview API reference Webhooks Zapier, Make & Pabbly AI assistants (MCP)Help centre

Loading…

PropZolo API — OpenAPI 3.1 at /api/v1/openapi.json

Terms Privacy Legal & credits

PropZolo API

The REST API behind the PropZolo web and Android apps. Push leads in, read and update your CRM from your own systems, receive signed webhooks, and connect Zapier, Make or Pabbly.

Search the API

Getting started

An owner or admin creates an API key in Settings → Integrations → API keys, with only the scopes the integration needs (leads:write, leads:read…). A key acts as its creator, limited to its scopes.
Send it on every request: Authorization: Bearer pz_live_….
Base URL: https://api.propzolo.com — paths are listed in the API reference.

Conventions

Success: { data, meta }; failure: { error: { code, message, fields?, request_id } }.
Money is integer paise (₹1 = 100). Instants are ISO 8601 in UTC; dates are the company’s calendar.
Lists are keyset-paginated: pass meta.next_cursor back as cursor while has_more is true.
Writes that document it honour Idempotency-Key: a retry replays the first answer.
Every answer carries X-Request-Id — quote it to support.

Rate limits

600
requests per minute per API key
120
requests per minute per IP on public endpoints
429
when over a limit — wait for Retry-After seconds

Some endpoints set tighter limits (creating keys, sending tests).

API areas

AICopilot drafts and summaries, explain-this-lead, lead score, requirement proposals, listing copy, plain-words search and the inventory inbox — validated, metered on the AI wallet and audited.37 endpoints
AI agentsThe WhatsApp AI agent: settings, the per-number switch off → shadow → live behind the agent check, approved facts, KPIs, inbox drafts and hand-offs.21 endpoints
AI assistantsClaude, ChatGPT and other assistants through MCP: consent, connections, drafts waiting for approval, the call log and the company policy with its kill switch.15 endpoints
AI voice agentCalls from declared A2P numbers in Hindi, English or Hinglish (N-01): new-enquiry callbacks within 60 s, missed calls, visit confirmations and feedback, grounded on the lead and inventory, with live transfer to a member; settings, the live / recent monitor and transcripts.8 endpoints
AccountThe signed-in person: profile, email and phone changes, password, two-step verification and sessions.17 endpoints
AccountabilityFollow-up discipline scores (0–100) per member with explained components, trends, the team ranking and the optional rotation eligibility.4 endpoints
Ad conversionsQualified leads, site visits and bookings of ad leads sent back to Meta and Google Ads: settings, test events, the delivery log and objections.15 endpoints
ApprovalsHuman approvals: workflow steps and approval chains of guarded actions (exports, deletes, discounts, rent below the floor, brokerage, stage gates) — levels, holds, bulk decisions, signed links, WhatsApp, the policies.15 endpoints
AssignmentLead routing: rules and their simulator, routing profiles, the assignment log, pools, SLA, staff exit.25 endpoints
AttendancePunch in / out with geofence and selfie (offline-safe, tamper signals), breaks, live location on duty with consent, the team view, corrections, the attendance register and field report, settings and sites.20 endpoints
Automation toolsZapier, Make and Pabbly: REST-hook subscriptions and polling triggers for API keys.9 endpoints
AutomationsWorkflows (trigger → conditions → actions, delays, waits, goals), versions, dry runs, run logs and recipes.19 endpoints
Bank reconciliationBank statements (CSV / Excel, per bank) matched to rent UTR claims, deal receipts and booking payments by UTR, amount and date (N-10): clear matches confirmed by rule, near ones reviewed; never applied twice.10 endpoints
BillingThe PropZolo subscription (plans, seats, checkout, proration), GST invoices, prepaid wallets, the onboarding checklist and support-access grants.16 endpoints
Bookings19 endpoints
Broker networkThe co-broking network (N-03): the network profile with RERA / KYC badges and trust signals, the directory, circles, masked shares of listings and requirements with availability checks, matches, co-broke deals with frozen split terms, deal rooms and client registration locks.32 endpoints
Calendar syncMembers’ own Google / Microsoft 365 calendars: PropZolo’s calendar with visits and meetings, free/busy blocks for the visit scheduler (times only), and disconnect.7 endpoints
Call insightsCall intelligence: summary, outcome and hot signal, objections with quotes, promised call-backs proposed as tasks, requirement fields proposed for review, QA scorecards on the company rubric, overrides, trends and the coaching queue.10 endpoints
Call listWho to call today: the ranked list with reasons (call now, later today, done), skips and snoozes, a manager’s view of a member’s list, and the list’s settings.6 endpoints
Calling queueWho to call next — the Autopilot dial brain with calling hours, cool-downs and caps.2 endpoints
CallsThe call log, call cards, outcomes, analytics, agent phones, daily targets and call-tracking settings.21 endpoints
Campaign spendSpend entries per campaign and source per period, behind cost per lead / visit / deal and source ROI.4 endpoints
CampaignsFollow-up plans (steps, business-day delays, enrolments, pause rules, step analytics) and broadcasts (audience snapshot, approval, throttled sending, stats).32 endpoints
Channel partners28 endpoints
Channel-partner brokerage13 endpoints
CollectionsBuilder collections on bookings: construction stages, demand letters and reminders, receipts with 194-IA TDS, late interest, ledger, ageing, cancellation, refunds and transfers.25 endpoints
CommissionsCommission payouts to members and co-brokers (records; TDS and invoices in Phase 2).4 endpoints
CompanyCompany profile, RERA & GST, branding, business hours & holidays and the security policy.12 endpoints
ConsentConsent ledger (DPDP / TRAI): grants, withdrawals, the contact consent panel and the suppression list.8 endpoints
ContactsPeople behind leads, listings and deals — one per phone number; numbers masked with an audited reveal.7 endpoints
Custom fieldsExtra fields of leads, contacts and listings: types, choices, required, per-role visibility.5 endpoints
Customer portalThe buyer / owner / tenant portal (OTP sign-in for contacts): the construction updates members publish for buyers and the referrals portal users send.5 endpoints
DashboardThe adaptive dashboard: your day, KPI tiles with deltas, the pipeline and the live team board.3 endpoints
Data & privacyDPDP: versioned privacy notices, rights requests with the 90-day clock (access reports, corrections, erasure), retention policies and legal holds, the audit log and the full company export.30 endpoints
DealsResale, new-booking and rental deals: stages, parties, values, documents, commission terms and splits.16 endpoints
Email syncMembers’ own Gmail and Outlook mailboxes (opt-in, read-only): emails with known contacts on the timelines, the company policy, private emails and the email viewer.10 endpoints
ExportsLead exports with permission, row caps, watermark and an export log.4 endpoints
Finance34 endpoints
Follow-up agentGoal-based follow-up on a lead (book a visit, collect documents, get a decision, revive): AI drafts each touch within the company’s rules, the owner approves, edits or rejects it (autopilot only where allowed), every send goes through the messaging gates and a reply, an opt-out or the goal being met hands the lead back.10 endpoints
FormsHosted and embeddable enquiry forms: fields, versioned consent, phone OTP, spam protection, embedding.5 endpoints
HelpHelp articles for the in-app help sheet, “Was this helpful?” votes and the first-run tips you closed.6 endpoints
ImportsCSV / Excel imports of leads, contacts, listings, deals, notes and tasks: templates, dry run, rollback.11 endpoints
IntegrationsConnector catalogue, connections and their health, Meta Lead Ads and Google Ads lead forms.26 endpoints
IntegrityIntegrity alerts for managers (never shown to the agent concerned): review, dismiss, reopen.4 endpoints
Inventory inboxWhatsApp-group inventory (I-06): chat-export uploads, pastes and shares, the review queue of listings and requirements clustered across groups (freshness, demand, price history), decisions and read-only group capture.20 endpoints
Landing pagesProject, listing and campaign pages from template blocks, with the RERA publish rules and SEO.22 endpoints
Launch modeProject launches: EOIs with unit preferences, a verifiable commit-reveal draw, automatic or live allotment (B-01 holds for the booking desk), the launch-day queue and dynamic pricing rules that draft the next price list.21 endpoints
Lead Push APIPublic per-source URL to push leads as JSON, form posts, XML or a GET query string.2 endpoints
Lead sourcesSources with cost, defaults, ingestion endpoints, health, logs with replay and the ingestion dashboard.22 endpoints
LeadsLeads with requirement, owners, the status sheet, duplicate check, merge and bulk actions.18 endpoints
Linked WhatsAppUnofficial, opt-in: agents link their own WhatsApp by QR for 1:1 chats and replies they type — risk acceptances, company switch, devices.10 endpoints
Listing freshnessOwner “still available?” pings with a tracked link, stale listings, price-revision nudges and their settings.5 endpoints
Listing verificationThe Verified badge: an agent’s visit with geotagged photos near the listing plus an ownership-document check, reviewed by someone else; expiry, invalidation and revocation.20 endpoints
Loan deskHome-loan cases of leads and deals: eligibility (FOIR, EMI, RBI LTV slabs), the document checklist, hand-off to a lender with a document-pack link, sanction and disbursal tranches, lenders, DSAs and the commission ledger.37 endpoints
Login devicesDevice binding and login approvals: sign-in rules (approvals for new devices, device limits), members’ devices and the approvals inbox for managers and admins.9 endpoints
Marketing studioAI ad copy per placement and language grounded on CRM facts (RERA line and disclaimer attached), branded creatives from listing photos, social posts on a calendar, and ad audiences synced as hashed identifiers with booked-buyer suppression.31 endpoints
MatchingExplainable requirement ↔ listing matches for leads and listings.4 endpoints
MediaPhotos, plans, videos and private documents of listings and projects.7 endpoints
MessagingCompliance-gated sending (WhatsApp, DLT SMS, email), message status, inbox conversations and sending identities.32 endpoints
MobileThe Android app: phone registration, push tokens, device tokens and the unknown-caller lookup.13 endpoints
NotificationsBadge counters, the member’s notifications and notification preferences.7 endpoints
Owner reportsLive listing performance for owners on a magic-link page (views, enquiries, visits, feedback, offers), the periodic report by email or WhatsApp, links (issue, renew, rotate, revoke) and lines curated for owners.15 endpoints
Partner portal21 endpoints
Payment linksRazorpay / Cashfree payment links for a deal’s token or brokerage, sent or copied, with automatic receipts.4 endpoints
PipelinesPipelines, statuses and sub-statuses: order, colours, categories, status-sheet requirements, SLAs.14 endpoints
Portal syndicationListings published to property portals where a feed / API exists: per-portal rules in plain words, status, take-down, retries, the dashboard, accounts and defaults (N-06).9 endpoints
Post-sales17 endpoints
Predictive scoringThe company’s own model of the chance of a site visit or booking within 14 days: whether it ranks the leads and why, data readiness, lift, calibration and feature importance, version history, the switch and retraining.3 endpoints
Pricing & cost sheets21 endpoints
Process guardPer-pipeline stage gates: allowed next stages, entry requirements, checklists with parallel sub-steps, automatic moves, the next-steps view and hand-ticked items.8 endpoints
ProjectsNew-booking project catalogue: developers, RERA numbers, configurations and price ranges.12 endpoints
PropertiesResale and rental listings: fields, statuses, price history, key register, map search and saved views.20 endpoints
QR codesDynamic QR codes per placement (hoarding, newspaper, site board, brochure, event stall, CP flyer) with attribution, validity windows, scan analytics (unique devices, leads, visits, won) and print-ready images and sheets.9 endpoints
Re-activationDatabase re-activation: dormant leads picked by preset and filter, reached only on a lawful channel (legal basis per lead), a hold-out group for the lift, the first batch’s approval, the AI agent re-qualifying replies and warm leads handed to people — funnel, lift, cost and the export.20 endpoints
RealtimeServer-Sent Events for notifications, inbox and live counters.1 endpoint
ReceiptsCommission receipts with mode-specific references and per-financial-year numbers.3 endpoints
Rent collectionAn agreement’s rent: the schedule (prorated, escalated, regenerated after amendments), UPI pay links to the landlord’s own UPI id with UTR capture, AutoPay / e-NACH mandates, payments, reversals and waivers, late fees with approval, HRA-ready receipts, the Rent board and the rent settings. Rent is never brokerage revenue.17 endpoints
Rental agreement settingsAgreement templates and the clause library, the stamp-duty table and company rules, e-sign status and e-stamp credits; inspection templates and the inspection & deposit settings.23 endpoints
Rental agreementsThe agreement document: templates per state and kind, clauses, stamp duty, PDF preview, e-stamp + Aadhaar e-sign through the partner, registration.20 endpoints
Rental depositsThe deposit ledger: who holds it (landlord, escrow partner, the brokerage in trust), money received, paid to the landlord and refunded (append-only), deductions from the comparison with the tenant’s answers, the settlement and the statement — never brokerage revenue.14 endpoints
Rental inspectionsMove-in / move-out inspections: room-by-room checklists, ratings, EXIF/GPS-free photo and video previews, meter readings, inventory and keys, captured offline-tolerant on the phone; signatures of both parties (typed name, drawing, one-time code) that lock the inspection; corrections; move-out compared side by side with move-in.20 endpoints
Rental maintenanceMaintenance tickets of managed rentals: WhatsApp intake with photos, AI triage the agent confirms, vendors with dispatch and update links, the owner’s approval above a threshold, SLA timers, the tenant’s confirmation.21 endpoints
Rental offersVersioned offer terms on rental deals, asked vs offered vs the owner’s floor, and the owner-floor approval (the owner’s decision link and/or the approval chain).8 endpoints
RentalsRental agreements, renewal reminders (T-60 / 45 / 30) and renewal deals.9 endpoints
Report builderReports you build: an entity, filters, a group-by and a split, measures (counts, totals, averages, conversion rates, cost per lead), charts, drill-down to records, private / team / company sharing and versions — always within the reader’s own report scope.13 endpoints
ReportsOwner dashboard, status matrices, speed to lead & SLA, agent scorecard, visits / shares / messaging reports, campaign costs and the daily owner digest — within your report scope.15 endpoints
SLA policiesFirst response, first call, first site visit, time in stage and overdue tasks on business-hours clocks, with the escalation ladder and the SLA dashboard.5 endpoints
Saved viewsPrivate and team views of the CRM lists, and counts for their tabs.5 endpoints
Scheduled reportsDaily, weekly or monthly delivery of a report by email (table + CSV) and WhatsApp (summary), the delivery log, outside recipients with step-up and one-click unsubscribe, and the daily owner digest as a schedulable preset.9 endpoints
SearchGlobal search behind the command palette.1 endpoint
SessionThe signed-in member and the workspace configuration clients load at start.2 endpoints
SharesTracked share links with views, reactions and hot signals.5 endpoints
Site visitsTours with conflict warnings, the calendar, reminders, the client OTP, GPS check-in / out, feedback, no-shows.21 endpoints
StatusLive platform health with incidents and planned maintenance — the data behind /status.1 endpoint
SupportTickets to PropZolo support: open one, follow the thread, reply with screenshots, mark it solved.6 endpoints
SystemHealth checks and this document.2 endpoints
TasksTasks and follow-ups: due times, reminders, recurrence, snooze, overdue / today / upcoming and the calendar.9 endpoints
TeamMembers, invitations, roles and the permission matrix, teams, branches and API keys (Settings → Team).28 endpoints
TelephonyCloud telephony (Exotel): the connection, virtual numbers per lead source with validity dates, A2P declarations, recording and missed-call settings.15 endpoints
TemplatesSMS (DLT), email and WhatsApp templates with variables, previews, the seeded library and DLT import.10 endpoints
TimelineThe timeline of a lead or a contact: notes with @mentions, status changes, calls, visits and system events.3 endpoints
Unit inventory33 endpoints
Voice debriefsShort spoken notes about a lead: upload, transcription (speech to text, metered), the AI’s proposed update with the words each part came from, review and apply (requirement, status, follow-up, tasks) — and the voice settings.10 endpoints
Walk-insSite-office kiosks (pairing, revoking, questions, branding), the walk-in policy (CP lock window, versioned consent notice) and the site-office queue with tokens, waiting times and site visits.12 endpoints
WebhooksSigned outgoing webhooks: endpoints, events, secret rotation, test events, the delivery log and replays.11 endpoints
WhatsAppWhatsApp Cloud API: connect with your own credentials or Embedded Signup, numbers with quality and tier, templates with Meta.12 endpoints
White labelEnterprise white label (N-09): brand name, accent colour, "powered by", email sender, workspace domains verified by DNS and the branded Android app’s build manifest.7 endpoints