BrokerPlus API (beta)
BrokerPlus API (beta)
The BrokerPlus REST API.
This API is in beta. Any endpoint here can change in a way that breaks your integration, and it can change without notice. Build defensively: ignore a field that you do not recognize, instead of failing on it. Read the changelog for every change we make.
Authenticate with Authorization: Bearer <your key>. A key acts as the broker who created
it. It can do everything that broker can do in the app, and nothing more.
Every field name is snake_case. Every timestamp is an ISO 8601 string in UTC. Every
calendar date is a YYYY-MM-DD string, because a date column holds no time and no time
zone.
Tags
Identity
Verify a key and see who it acts as.
Assistant
The standing instructions a broker gives their assistant.
Users
The brokers in the brokerage. Resolves every broker id on this surface.
Teams
Broker teams. Each is owned by exactly one broker.
Pipelines
Deal boards and their stages. Resolves a deal's board and stage ids.
Contacts
People and companies in the book, with their notes and tags.
Leads
Inbound prospects, before they become deals.
Lead forms
The forms a broker puts on a website, and the leads each one brought in.
Deals
The mortgage pipeline, with its notes and tags.
Documents
Files on a deal, and short-lived download links.
Conditions
What a lender still needs before a deal can close.
Mortgage
The mortgage record on a deal: loan terms, the property, the applicants and their financials.
Opportunities
The book of tracked mortgages, with the penalty to break and the savings from moving.
Submissions
Deals sent to a lender, and what the lender answered.
Compliance
The brokerage's compliance setup: package templates, the compliance program, retention, monitoring alerts and policies.
Lenders
The lenders a brokerage places business with.
Rates
The rates the broker and the brokerage set on the Rates page, as a PERCENT.
Appointments
The broker's calendar.
Scheduling
Meeting types, their open times, and bookings made into them.
Communications
Email, calls and messages on a deal or a contact.
Calls
The call log, with transcripts and recaps. Log a call from another phone system or recorder.
Call lists
Lists of people to phone, worked one row at a time, and the call scripts read on those calls.
Tags
The brokerage's tag vocabularies. Contacts and deals have separate ones.
Tasks
The action queue. Read, edit, complete, cancel, and reopen, with notes.
Campaigns
Newsletters and mass messages, their audiences, and who opened or opted out.
Templates
The email and text templates in the Pulse library, and the merge fields they can use.
Automations
Pulse automations: what starts each one, and the messages it sends.
Equity reports
The monthly reports past clients receive, and what each client did with one.
Retention signals
Why to reach a past client now: an equity drop or a date of theirs, and the broker's date triggers.
Reports
The pipeline and funded volume, as the Business pages show them, and the report builder: report templates and bulk report runs.
Data hub
Exports of the broker's data, and the imports that bring a book into BrokerPlus.
Planning
What a broker builds to advise a client: mortgage plans, lender offers and their side-by-side comparison, deal scenarios, and strategy analyses.
Referral partners
Who sends the broker business, what it was worth, and what the broker sent back.
Client surveys
NPS surveys sent to clients, their scores, and the alert rules a score sets off.
Compliance forms
The forms a broker emails a client to fill in and sign: the PEP declaration and consent forms.
Client tracker
The stages a client sees on their hub, in the broker's words, and the stages each deal reached.
Intakes
The application a client fills in themselves: the standing link anybody can start from, and one intake per client.
Request templates
The broker's request library: the templates a broker builds to ask clients for answers, documents and signatures.
Webhooks
Push notifications for 21 event types.
Changes
An ordered log of every change to the records, for a sync that misses nothing.
Sandbox
A test brokerage with synthetic data, where nothing is sent to a real person.
Custom fields
Intake
Notes
Suggestions
Notifications