Forecast · CRM · API reference | MB Suite Developers

GET/v1/crm/forecast

Get the weighted forecast of a pipeline

crm.forecast.get

ReadIdempotentSince 2026-11-01

Weighted forecast of the open deals of one pipeline whose expected close date falls in the period (deals without a close date are included too): open value, weighted value (each deal's value × its probability), best case (probability ≥ 50) and committed (probability ≥ 90). The probability is the one set by hand on the deal, otherwise its stage's current probability (a deal that kept the number of a stage it left is not counted with it), and the one stored on the deal only when its stage has none. It is broken down by stage and by owner (with the name the CRM team shows), in one currency (each deal converted with today's rate; the organization's reporting currency, else the pipeline's). Archived and merged deals are left out. Members without view_all_performance only get their own deals. Not found if the pipeline does not exist; crm.pipelines.list gives the ids.

Scope: crm:read
Permission: View the module · CRM action: view_performance
MCP tool: crm_forecast_getOn the full surface; on the compact one, mb_execute_operation with id: "crm.forecast.get".

Declared cost: up to 30003 reads and 0 writes per call (they count against the daily quota).

Parameters

pipeline_idstringqueryrequired

Pipeline id from crm.pipelines.list.

startintegerqueryrequired

Start of the period, on the deals' expected close date (epoch ms); deals without a close date are included.

endintegerqueryrequired

End of the period (epoch ms), not before start.

owner_idstringqueryoptional

Only the records of this owner: a user_id from crm.team.list.

Response

pipeline_idstring

pipeline_namestring

currencystring

Currency of every amount: each deal is converted to it (today's rate) before summing; the organization's reporting currency, else the pipeline's.

open_deals_countnumber

open_valuenumber

weighted_valuenumber

best_case_valuenumber

committed_valuenumber

stagesarray<object>

ownersarray<object>

fx_unconvertedarray<object>

Currencies without an exchange rate: their deals are left out of the amounts (currencies are never mixed in a sum).

truncatedboolean

Errors

crm_action_denied invalid_input unknown_field authentication_required scope_insufficient module_access_denied operation_not_found rate_limited quota_exceeded

Example

curl "https://api.mb-suite.com/v1/crm/forecast?pipeline_id=PIPELINE_ID&start=0&end=0" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/crm/forecast?pipeline_id=PIPELINE_ID&start=0&end=0" \
  -H "Authorization: Bearer $MB_TEST_KEY"