# BrokerPlus API

> The BrokerPlus REST API, in beta: about 300 operations over leads, contacts, deals, mortgage applications, documents, tasks, scheduling, messages, campaigns, automations, equity reports, and webhooks.
> Any endpoint can change in a breaking way without notice. Base URL: https://api.mos.getbrokerplus.ca/v1

## API description

- [OpenAPI description](https://docs.brokerplus.ca/openapi.json): every endpoint, parameter, and field, as OpenAPI 3.
- [All pages in one file](https://docs.brokerplus.ca/llms-full.txt)
- [MCP server](https://mcp.mos.getbrokerplus.ca/mcp): the same API as Model Context Protocol tools. See https://docs.brokerplus.ca/mcp.md.

## Documentation

- [Make your first call](https://docs.brokerplus.ca/quickstart.md): Create an API key, check who it acts as, and read your first contacts.
- [Templates](https://docs.brokerplus.ca/templates.md): Write the email and text templates that automations send, with merge fields that fill in the client's details.
- [Mail](https://docs.brokerplus.ca/mail.md): Read a connected mailbox, act on a conversation, and get told when new mail arrives.
- [Log calls from your phone system](https://docs.brokerplus.ca/log-calls.md): Put calls, transcripts, and recaps from another phone system or recorder in the BrokerPlus call log, on the right contact and deal.
- [Authentication and keys](https://docs.brokerplus.ca/authentication.md): API keys, the limits you can put on a key, signing in an assistant without a key, and the rate limit.
- [Ask a client for something](https://docs.brokerplus.ca/client-asks.md): Request documents, explain conditions, send documents to sign, and send generated letters, each in the broker's name.
- [Pagination](https://docs.brokerplus.ca/pagination.md): How to page through a list, and the order each list comes back in.
- [Run an intake](https://docs.brokerplus.ca/intake.md): Send a client the application they fill in themselves, follow their progress, read the answers, and approve it or ask for changes.
- [BrokerPlus API](https://docs.brokerplus.ca/introduction.md): Connect your website, your data warehouse, your old CRM, or an AI assistant to BrokerPlus. Start from the job you want done.
- [Units and formats](https://docs.brokerplus.ca/units.md): How the API writes rates, money, dates, times, ids, and names, so you can do arithmetic on a field without guessing.
- [Compliance setup](https://docs.brokerplus.ca/compliance.md): Read and change the brokerage's compliance setup through the API - package templates, a deal's compliance package, the compliance program, and e-signing rules.
- [Automate client follow-up](https://docs.brokerplus.ca/automations.md): Build the same Pulse automations a broker builds in BrokerPlus, turn them on, and read their runs.
- [Changelog](https://docs.brokerplus.ca/changelog.md): Every change to the API, newest first.
- [Webhooks](https://docs.brokerplus.ca/webhooks.md): React to events in your book - register a URL, verify the signature, and handle each delivery.
- [Staying in sync](https://docs.brokerplus.ca/sync.md): The three ways to learn what changed in BrokerPlus - the change feed, webhooks, and updated_since - and which one to use.
- [Sync your book](https://docs.brokerplus.ca/sync-your-book.md): Keep a copy of your contacts, leads, and deals current in your own database, without losing a row.
- [Equity reports](https://docs.brokerplus.ca/equity-reports.md): Enroll past clients in recurring equity reports, pause or stop them, send one now, and read what each client was sent.
- [Idempotency and batch](https://docs.brokerplus.ca/idempotency.md): Retry a request safely after a timeout, and write up to 100 records in one call without making duplicates.
- [Reaching clients](https://docs.brokerplus.ca/reaching-clients.md): Which requests email, text, book, or otherwise reach a client, and how to keep a key from making them.
- [Rates](https://docs.brokerplus.ca/rates.md): Read and set the rates a broker and a brokerage keep on the Rates page, which drive the refinance, renewal, and penalty figures in BrokerPlus.
- [Migrate from another CRM](https://docs.brokerplus.ca/migrate-from-a-crm.md): Move contacts, deals, notes, and custom fields from another CRM into BrokerPlus, with no duplicates and inside the rate limit.
- [Test in a sandbox](https://docs.brokerplus.ca/sandbox.md): Build against a private brokerage full of sample data that never emails, texts, pulls credit, or submits to a lender.
- [Configure your workspace](https://docs.brokerplus.ca/workspace.md): Create and change the custom fields, tags, pipelines, stages, meeting types, and other settings a brokerage keeps in BrokerPlus.
- [How the objects fit together](https://docs.brokerplus.ca/model.md): What each object is, how the objects relate, and which id resolves through which endpoint.
- [Capture leads from your website or ads](https://docs.brokerplus.ca/capture-leads.md): Send every form submission or ad lead to BrokerPlus exactly once, with no duplicate people.
- [Suggestions, notifications, and deal checks](https://docs.brokerplus.ca/broker-view.md): Read what the broker sees in BrokerPlus - suggestions, notifications, a deal's compliance and credit, the activity trail, and goals.
- [Plans and comparisons](https://docs.brokerplus.ca/planning.md): Build mortgage plans, lender offers, deal scenarios, and strategy analyses for a client through the API.
- [Reports and data](https://docs.brokerplus.ca/reports-and-data.md): Save report templates, make a PDF report for many deals at once, and export the broker's data.
- [Documents](https://docs.brokerplus.ca/files.md): List, upload, file, and download the documents on a deal, and see what a client still owes.
- [Errors](https://docs.brokerplus.ca/errors.md): The error shape, the codes you will see, and which failures are safe to retry.
- [Run an AI assistant](https://docs.brokerplus.ca/mcp.md): Connect Claude, ChatGPT, or any MCP client to BrokerPlus, and let it read your book and do routine work for the broker.