Get a roadmap. Gets an internal roadmap: its scoring factors and formula, and its posts ranked by score with each factor's raw and normalized value, impact, effort and MRR at stake. Filter with the post DSL, sort, group by status, owner, category, board or tag, or apply a saved roadmap view. Scores refresh within a minute of votes or MRR changing. Team only. No side effects.
Toolset
planning
Who can call it
OwnersManagersContributorsAPI keys
REST
POST /api/v1/w/{workspace}/roadmaps/{roadmap}/query
Behavior
read-onlyidempotent
Input
Field
Type
Description
roadmaprequired
string
The roadmap's name or ID (rdm_…).
view
string
A saved roadmap view (name or ID): its filter, sort and grouping apply.
filter
object
Only items matching this post filter (DSL, as in search_posts).
sort
one of: score, impact, effort, votes, created, added, manual
score (default), impact, effort (lowest first), votes, created, added, or manual (the team's own order, set with rank_roadmap_post).
group_by
one of: status, owner, category, board, tag
Group items by status, owner, category, board or tag (a post with several tags appears under each). Grouped results aren't paged: each group lists up to limit items.
limit
integer
Items per page (or per group), max 200. Default: 50.
cursor
string
Pass the previous response's next_cursor to get the next page.
Output
Field
Type
Description
roadmaprequired
object
totalrequired
integer
Items matching the filter.
sortrequired
one of: score, impact, effort, votes, created, added, manual
group_byrequired
one of: status, owner, category, board, tag or null
itemsrequired
array of object
The page of items (empty when grouped).
groupsrequired
array of object or null
next_cursorrequired
string or null
Cursor for the next page, or null when this is the last page.