Copy page

Getting started

BrokerPlus API

The BrokerPlus API gives your software the same book a broker works in BrokerPlus: leads, contacts, deals and their mortgage applications, documents, tasks, meetings, messages, campaigns, automations, and more, about 300 operations in all. It is JSON over HTTPS, with one API key.

Code
https://api.mos.getbrokerplus.ca/v1

New here? Make your first call in two minutes, then pick the job below that matches what you are building.

Start from the job

What you can do

Every area below is in the API reference, and in the MCP server for assistants.

Area	What you can do	Read
Leads and contacts	Create, find, update, merge, and archive people and companies, with addresses, extra emails and phones, consent, relationships, and tags.	Capture leads
Deals and pipelines	Create, move, copy, archive, and restore deals. Set the team, participants, referral partner, commission, consents, flags, and checklist.	How the objects fit together
Mortgage application	Read and write the loan terms, property, applicants, jobs, income, assets, debts, and other properties, one row at a time.	The application
Documents	List, upload, rename, verify, and delete files. Ask a client for documents, generate letters from templates, and send documents to sign.	Documents
Conditions and submissions	Track what a lender still needs, satisfy or waive it, and read what went to each lender and what they decided.	How the objects fit together
Tasks and notes	Create, assign, complete, and reopen tasks, one at a time or in bulk. Write notes on contacts, deals, and tasks.	How the objects fit together
Scheduling	Read open times, book a client into a meeting type, and move or cancel the booking. Manage meeting types, hours, and blocked days.	How the objects fit together
Messages, mail, and calls	Read the inbox and call log, act on a conversation, log calls from another phone system, and ask the broker to send a message.	Mail, Log calls
Campaigns and automations	Build audiences, campaigns, templates, and automations, and follow each run.	Automate client follow-up
Intake	Send a client the application to fill in, follow their progress, read the answers, and approve them or ask for changes.	Run an intake
Equity reports and opportunities	Track mortgages for renewal and refinance, and enroll past clients in recurring equity reports.	Equity reports
What the broker sees	Read and act on suggestions and notifications, and read a deal's compliance checklist, credit summary, and activity trail.	Broker view
Workspace setup	Change custom fields, tags, pipelines and stages, lead stages and channels, referral partners, task categories, and the email signature.	Configure your workspace
People and reports	Read brokers, teams, lenders, referral partners, the open pipeline, and funded volume.	API reference
Change feed and webhooks	Follow every change in order, and get a signed POST for 23 kinds of event.	Staying in sync, Webhooks

A request that reaches a client, such as an email, a text, a booking, or documents to sign, goes out at once, as the broker. A key with the no_sending limit cannot make these requests. See Reaching clients.

What is never in the API

Some things stay in the BrokerPlus app, where a person with the right role does them. No key can reach them.

• Submitting a deal to a lender. You can read submissions and lender decisions, but only the broker sends a deal.
• Pulling credit. You can read the summary of a credit report that is already on a deal, not order one.
• Billing, plans, and payments.
• Users and roles: inviting people, changing roles, or minting API keys.
• Integration credentials, phone numbers, deal locks, and compliance overrides.
• Sensitive identifiers: social insurance numbers, liability account numbers, and ID documents are never returned.

A liability that came from a credit report carries from_credit_bureau: true. Consumer report data has its own redistribution rules, so check your obligations before you store or forward it.

This API is in beta

Any endpoint can change in a way that breaks your integration, without notice. We publish an endpoint when it is useful, not when it is frozen, which is why the surface is this wide. Build defensively: ignore fields you don't recognize, and don't assume today's shape is next month's.

The changelog records every change. It is the one page to watch. If you need a promise that a shape will not move, talk to your account contact before you build on it.

Docs for AI agents

Every page is also plain Markdown: add .md to its URL, for example /introduction.md. /llms.txt indexes every page, /llms-full.txt has them all in one file, and the OpenAPI description has every endpoint and field. Give an agent these URLs instead of the HTML pages.