Developers

Everything you can see or do in the app, you can do through the API, and every change can be pushed to you by webhook. Leads, customers, messages, status and job totals, charges and credits, reviews, business settings, metrics and the webhook log are all here.

Base address: https://zqawbbylldymdfzineqq.supabase.co/functions/v1/pro-api.

Who are you?

  • A pro connecting your own tools (your CRM, Zapier, a spreadsheet, your own server): make an API key in My account, Settings, Connect your software. No approval needed. Start with the quick start.
  • A software company connecting many pros (a CRM, field service or scheduling app): create a partner app at /partners and use OAuth. New apps start in sandbox; verified apps can connect any pro.

Pull and push

  • Pull (API): your software asks for changes and sends updates back. Any tool that can make a web request works.
  • Push (webhooks): we send every new lead, message, status change, charge, credit decision and review to your address within a minute, signed so you know it came from us.

Use both: webhooks for speed, a pull every 5 to 15 minutes as a safety net.

Reference

  1. Quick start
  2. Authentication, keys and scopes
  3. Leads and the lead object, statuses
  4. Messages
  5. Customers and lookup
  6. Charges and credits
  7. Reviews, business settings and metrics
  8. Webhooks, delivery log and replay
  9. Polling, errors, limits and idempotency
  10. Partner apps and OAuth
  11. Security, test mode, changelog

Connection guides

Housecall Pro, Jobber, ServiceTitan, Zapier, Make, Google Sheets, your own server.

Promises

  • Real contact details after you accept a lead: the customer's own phone and email, never a relay number, so your CRM can match them.
  • Every object carries your own ids (external_ids) and can be looked up by them, by phone or by email.
  • Every list syncs incrementally (since and cursor); every write can carry an Idempotency-Key.
  • Rate limits are published and returned in headers on every call.
  • Every scope in these docs can be granted.
  • Use the API under the API Terms.

All guides