Equity reports
The monthly reports past clients receive, and what each client did with one.
List equity reports
The monthly reports sent to past clients, newest first. The figures are the snapshot the client was sent, not today's numbers; read today's numbers from GET /v1/opportunities. cta_clicked_at is the client asking for a call.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
deal_idReturn only reports for this deal.
contact_idReturn only reports about this client: reports built from a deal the contact is on.
statusReturn only reports in this state.
List equity reports › 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.
List equity report sends
Every time an equity report went out to a client, newest first, the same history as Outreach History in BrokerPlus. A report the client got twice is listed twice. To see whether the client opened it, read GET /v1/equity-reports/interactions.
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 sends at or after it, in sent_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 sent_at and id of the last row you read. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
deal_idReturn only sends for this deal.
contact_idReturn only sends to this client.
report_idReturn only sends of this report.
channelReturn only sends on this channel.
statusReturn only sends with this status.
List equity report sends › 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.
List equity report interactions
What clients did with their reports, newest first: opened the email, opened the report, asked for a call, or corrected a figure. A correction the client made is held for the broker to accept or refuse in BrokerPlus.
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 interactions at or after it, in created_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 created_at and id of the last row you read. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
deal_idReturn only interactions with reports for this deal.
report_idReturn only interactions with this report.
fieldReturn only this kind of interaction.
List equity report interactions › 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.
List clients' equity report corrections
The corrections clients made to their equity reports: the property's address, its value, or the mortgage balance. A pending one waits for the broker, as on the report changes queue in BrokerPlus. Newest first, or oldest first with updated_since.
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.
statusOnly corrections in this state.
deal_idOnly corrections on this deal.
List clients' equity report corrections › 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.
Accept a client's equity report correction
Writes the client's figure onto the deal, and the correction becomes applied. Nothing is sent to the client; their next report shows the new figure.
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.
Accept a client's equity report correction › Responses
Success
successAlways true on a successful response.
The requested record.
Decline a client's equity report correction
Keeps the deal's figure, and the correction becomes rejected. A declined property value is taken back off the client's report. Nothing is sent to the client.
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.
Decline a client's equity report correction › Responses
Success
successAlways true on a successful response.
The requested record.
Start a client's recurring equity reports
Enrolls clients in recurring equity reports now, the same as adding clients to recurring reports in BrokerPlus. The response has a line for each deal. Each enrolled client gets their first report when it falls due, at frequency. A client who opted out of reports or is under a sanctions freeze is refused, the same as in BrokerPlus. A deal that is already enrolled is unchanged; change its cadence with POST /equity-reports/frequency. A key with the no_sending limit cannot do this.
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.
Start a client's recurring equity reports › Request Body
deal_idsThe deals to act on, 1 to 100. A deal is the unit of a report: the client is its primary applicant and the property is its subject property. Find a client's deals with GET /v1/deals?contact_id=.
frequencyHow often the report goes out: monthly, quarterly, semi_annually, or annually.
Start a client's recurring equity reports › Responses
Success
successAlways true on a successful response.
The requested record.
Resume paused equity reports
Restarts the reports of paused clients now. The response has a line for each deal. The reports continue on their cadence. A key with the no_sending limit cannot do this.
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.
Resume paused equity reports › Request Body
deal_idsThe deals to act on, 1 to 100. A deal is the unit of a report: the client is its primary applicant and the property is its subject property. Find a client's deals with GET /v1/deals?contact_id=.
Resume paused equity reports › Responses
Success
successAlways true on a successful response.
The requested record.
Send an equity report now
Sends each client a one-off equity report now, the same as Send report in BrokerPlus. It does not enroll anybody. The response has a line for each deal. email sends from the broker's connected mailbox. sms sends a text with the report link. BrokerPlus checks each client's opt-out and consent as it sends, and skips a client who may not receive it. A key with the no_sending limit cannot do this. Supports Idempotency-Key: a retry with the same key gets the first response and sends nothing again.
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.
Send an equity report now › Request Body
deal_idsThe deals to act on, 1 to 100. A deal is the unit of a report: the client is its primary applicant and the property is its subject property. Find a client's deals with GET /v1/deals?contact_id=.
channelemail sends the report from the broker's connected mailbox. sms texts the client a link to it.
sms_bodyFor sms only: the text, with merge fields as in BrokerPlus. Omit it to use the brokerage's report text.
Send an equity report now › Responses
Success
successAlways true on a successful response.
The requested record.
Pause clients' equity reports
Pauses the recurring reports of enrolled clients now, the same as a pause in BrokerPlus. The clients stay enrolled and no report goes out until you resume them. A deal that is already paused is unchanged. A deal that is not enrolled is refused.
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.
Pause clients' equity reports › Request Body
deal_idsThe deals to act on, 1 to 100. A deal is the unit of a report: the client is its primary applicant and the property is its subject property. Find a client's deals with GET /v1/deals?contact_id=.
Pause clients' equity reports › Responses
Success
successAlways true on a successful response.
The requested record.
Stop clients' equity reports
Takes clients off recurring equity reports now, the same as removing them from recurring reports in BrokerPlus. The reports they were already sent stay readable. A deal that is not enrolled is unchanged.
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.
Stop clients' equity reports › Request Body
deal_idsThe deals to act on, 1 to 100. A deal is the unit of a report: the client is its primary applicant and the property is its subject property. Find a client's deals with GET /v1/deals?contact_id=.
Stop clients' equity reports › Responses
Success
successAlways true on a successful response.
The requested record.
Change how often clients get equity reports
Sets the cadence of the reports for each deal now. It does not enroll a client, and it sends nothing. A deal with no opportunity yet is refused; enroll it first.
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.
Change how often clients get equity reports › Request Body
deal_idsThe deals to act on, 1 to 100. A deal is the unit of a report: the client is its primary applicant and the property is its subject property. Find a client's deals with GET /v1/deals?contact_id=.
frequencyHow often the report goes out: monthly, quarterly, semi_annually, or annually.
Change how often clients get equity reports › Responses
Success
successAlways true on a successful response.
The requested record.