Referral partners
Who sends the broker business, what it was worth, and what the broker sent back.
List introductions to partners
The clients and leads the broker introduced to referral partners, newest first: the sent side of the Partners page. Only introductions where the broker can read both people are listed.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
partner_contact_idOnly introductions to this partner.
introduced_contact_idOnly introductions of this client or lead.
deal_idOnly introductions for this deal.
List introductions to partners › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Record an introduction
Records that the broker introduced a client or lead to a partner, as the Partners page does. A person is introduced to a partner once: recording the same pair again changes the note, deal, and date of the one introduction. BrokerPlus sends nothing to either of them.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Record an introduction › Request Body
partner_contact_idThe partner's contact. Find it from contact_id in GET /v1/referral-partners.
introduced_contact_idThe contact of the client or lead the broker introduced.
deal_idThe deal the introduction was for.
noteA note on the introduction.
occurred_at^(?:(?:\d\d[2468][04…When the broker made the introduction, as ISO 8601. Defaults to now on a new introduction.
Record an introduction › Responses
Success
successAlways true on a successful response.
The requested record.
List partner firm notes
The brokerage's notes on its partners' firms, by firm name. A note usually says which office the firm's partners work from. Every broker in the brokerage reads and writes the same notes, as on the Partners page.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
companyOnly the note on this firm. Case is ignored.
List partner firm notes › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Write a partner firm note
Writes the note on a firm. A firm has one note: if it already has one, this replaces its text and returns the same note.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Write a partner firm note › Request Body
companyThe partner firm. Case is ignored: the note is saved under the spelling the brokerage's partners already use.
noteThe note, at most 2000 characters. To remove a note, delete it.
Write a partner firm note › Responses
Success
successAlways true on a successful response.
The requested record.
Update a partner firm note
Replaces the text of the note.
path Parameters
idResource id.
Update a partner firm note › Request Body
noteThe note, at most 2000 characters. To remove a note, delete it.
Update a partner firm note › Responses
Success
successAlways true on a successful response.
The requested record.
Read the referral partner book
Every referral partner in the brokerage, with what they sent the broker and what the broker sent them, as the Partners page shows it. The figures cover the whole history unless you send a period. This is one summary, not a paged list.
query Parameters
periodThe period to sum: all, ytd, qtd, mtd. Defaults to all. Do not send it with start and end.
startThe first day of a custom period, as YYYY-MM-DD. Send it with end.
endThe last day of a custom period, as YYYY-MM-DD. Send it with start.
Read the referral partner book › Responses
Success
successAlways true on a successful response.
The requested record.
Retrieve a referral partner
One partner with the people they referred, the deals that funded, and the people the broker introduced to them. Use an id from GET /referral-partners or from a deal's referral_partner. The totals cover the whole brokerage. A key limited to teams lists only the people and deals its teams can read.
path Parameters
idResource id.
query Parameters
periodThe period to sum: all, ytd, qtd, mtd. Defaults to all. Do not send it with start and end.
startThe first day of a custom period, as YYYY-MM-DD. Send it with end.
endThe last day of a custom period, as YYYY-MM-DD. Send it with start.
Retrieve a referral partner › Responses
Success
successAlways true on a successful response.
The requested record.
List referrals between contacts
Who referred whom, newest referral first: each row is one person and the contact who sent them to the broker. A referral is listed when the broker can see the referred person. Filter by referrer_contact_id for everyone one partner sent.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
referrer_contact_idOnly people this contact referred.
referred_contact_idOnly the referral of this person.
deal_idOnly referrals linked to this deal.
statusOnly referrals in this status.
sourceOnly referrals of this kind.
List referrals between contacts › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Record who referred a contact
Records that one contact referred another, as Referred By on the contact page does. A person has one referrer: if the referred contact already has one, the referral is replaced, its other fields are kept unless you send them, and the response is 200 instead of 201.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Record who referred a contact › Request Body
referrer_contact_idThe contact who made the referral.
referred_contact_idThe contact who was referred. If this contact already has a referrer, the referral is replaced and the response is 200 rather than 201.
sourceDefaults to other.
statusDefaults to received.
noteThe broker's note about the referral.
deal_idThe deal the referral turned into.
occurred_at^(?:(?:\d\d[2468][04…When the referral was made. Defaults to now.
Record who referred a contact › Responses
Success
successAlways true on a successful response.
The requested record.
Update a referral
Changes the kind, status, note, linked deal or date of a referral. Only the fields you send change. To change who made the referral, record it again with POST /v1/contact-referrals.
path Parameters
idResource id.
Update a referral › Request Body
sourceWhat kind of person made the referral, for example realtor or past_client.
statusWhere the referred person is: received, contacted, in_progress, funded or dead. BrokerPlus sets funded itself when the linked deal funds.
noteThe note. null clears it.
deal_idThe deal the referral turned into. null unlinks it.
occurred_at^(?:(?:\d\d[2468][04…When the referral was made.
Update a referral › Responses
Success
successAlways true on a successful response.
The requested record.
List partner hubs
The partner hubs the broker opened, newest first. A partner hub is one page where a referral partner sees every file they are on with the broker. Use q to find the hub for a partner by name. A partner with no hub is not listed: open one with POST /partner-hubs.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
qText search over the partner's name, company, email and phone. Every word must match part of one of them. The same search as the search bar in BrokerPlus.
contact_idOnly the hub for this partner contact.
List partner hubs › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Open a partner hub and issue a link
Opens the partner hub for a contact and issues a link to it in link.url. If the partner already has a hub, you get that hub and a new link. If the broker turned the hub off, this turns it on again. Send show_funded or show_not_proceeding to choose which finished files the hub lists. BrokerPlus sends nothing: give the link to the partner yourself.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Open a partner hub and issue a link › Request Body
contact_idThe partner's contact. Find it with GET /v1/contacts or from contact_id in GET /v1/referral-partners.
show_fundedSet to false to remove the files that funded from the hub. If you omit it, the hub keeps its value.
show_not_proceedingSet to false to remove the files that ended without funding from the hub. If you omit it, the hub keeps its value.
Open a partner hub and issue a link › Responses
Success
successAlways true on a successful response.
The requested record.
Retrieve a partner hub
One partner hub, with its settings and the links that still work. A link does not include its address: issue a new link to get one.
path Parameters
idResource id.
Retrieve a partner hub › Responses
Success
successAlways true on a successful response.
The requested record.
Issue a partner hub link
Issues a new link to this partner hub and returns its address in url. BrokerPlus keeps only a fingerprint of a link, so a link issued before cannot be read back. Every link keeps working until the broker turns the hub off. If the hub is off, this turns it on again. BrokerPlus sends nothing: give the link to the partner yourself.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Issue a partner hub link › Responses
Success
successAlways true on a successful response.
The requested record.