Get the roadmap in a space (public reader)

Embed
Preview of the card
<a href="https://forumulate.com/reference/forumulate-api-publicroadmap-board"><img src="https://forumulate.com/reference/_api/public/orgs/046a9bc0-d530-43ae-9bae-af7945008cda/spaces/8042f004-e3d9-445f-b7a4-b6c1f86836e6/pages/dab55783-dd17-4640-be0b-2217e473d68d/social-card.svg?v=3e7ae33eec8b" alt="Get the roadmap in a space (public reader)" width="600" height="315"></a>
GEThttps://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/roadmap
Parameters
orgIdstringpathrequired
spaceIdstringpathrequired
limitintegerquery
Items per LANE — not lanes. The lanes are the status columns this board shows, so there is no page two of them; cursor goes one page deeper in every lane at once. Defaults to 100. 100 is the most this endpoint serves — a larger value is capped, not refused. A value that is not a whole number of 1 or more is a 422, never a silent default.
= 100
cursorstringquery
pageintegerquery
Which page of results to return, 1-based. Out-of-range pages return an empty list.
= 1
sharestringquery
previewstringquery
pinnedstringquery
Use true or false (true/1/yes/on and false/0/no/off are accepted).
true | 1 | yes | on | false | 0 | no | off
featuredstringquery
Use true or false (true/1/yes/on and false/0/no/off are accepted).
true | 1 | yes | on | false | 0 | no | off
tagstringquery
statusstringquery
minestringquery
Use true or false (true/1/yes/on and false/0/no/off are accepted).
true | 1 | yes | on | false | 0 | no | off
qstringquery
sortstringquery
top | new | trending
forumulate-versionstringheader
API version negotiation. Send forumulate-version: 2026-12-01 on every request from a new integration; it is optional only so that integrations written before versioning keep working. Each version includes everything before it:
Code samples
cURL
curl -X GET "https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/roadmap?limit=&cursor=&page=&share=&preview=&pinned=&featured=&tag=&status=&mine=&q=&sort=" \
  -H "forumulate-version: <value>"
TypeScript
const res = await fetch('https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/roadmap?limit=&cursor=&page=&share=&preview=&pinned=&featured=&tag=&status=&mine=&q=&sort=', {
  method: 'GET',
  headers: {
    'forumulate-version': '<value>',
  },
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/roadmap?limit=&cursor=&page=&share=&preview=&pinned=&featured=&tag=&status=&mine=&q=&sort=",
    headers={
    "forumulate-version": "<value>",
    },
)
data = res.json()
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/roadmap?limit=&cursor=&page=&share=&preview=&pinned=&featured=&tag=&status=&mine=&q=&sort=", nil)
	req.Header.Set("forumulate-version", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/roadmap?limit=&cursor=&page=&share=&preview=&pinned=&featured=&tag=&status=&mine=&q=&sort=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['forumulate-version: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/roadmap?limit=&cursor=&page=&share=&preview=&pinned=&featured=&tag=&status=&mine=&q=&sort=')
req = Net::HTTP::Get.new(uri)
req['forumulate-version'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/roadmap?limit=&cursor=&page=&share=&preview=&pinned=&featured=&tag=&status=&mine=&q=&sort="))
    .header("forumulate-version", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Success.
Example
{
  "anonymousVotes": true,
  "facets": {
    "tags": [
      {
        "count": null,
        "tag": null
      }
    ],
    "themes": [
      "string"
    ]
  },
  "filters": {
    "mine": true,
    "q": "string",
    "sort": "new",
    "status": "string",
    "tag": "string"
  },
  "following": true,
  "frontDoor": {},
  "frontPage": {
    "aside": {
      "doc": null,
      "phone": null,
      "width": null
    },
    "customization": {},
    "doc": {
      "content": null,
      "type": null
    },
    "gap": "lg",
    "hideTitle": true,
    "paddingBottom": null,
    "paddingTop": null,
    "preset": "string",
    "sidebar": {
      "divider": null,
      "doc": null,
      "gap": null,
      "phone": null,
      "position": null,
      "source": null,
      "startAfter": null,
      "width": null
    },
    "width": null
  },
  "homeDoc": {},
  "homeDocTranslations": {},
  "lanes": [
    {
      "items": [
        null
      ],
      "status": null
    }
  ],
  "preset": "string",
  "roadmap": "string",
  "statusLabels": {},
  "voteMode": "binary"
}
Option 1
anonymousVotesbooleanrequired
facetsobjectrequired
Show child parameters
tagsobject[]required
Show child parameters
countnumberrequired
tagstringrequired
themesstring[]required
filtersobjectrequired
Show child parameters
minebooleanrequired
qstringrequired
sortstringrequired
new | top | trending
statusstringrequired
tagstringrequired
followingboolean
frontDoorobjectrequired
frontPageStoredFrontPagerequired
Show child parameters
asideobject
Show child parameters
docobjectrequired
phonestring
after | hide
widthstring
default | narrow | wide
customizationobject
docobjectrequired
Show child parameters
contentobject[]required
typestringrequired
doc
gapstring
lg | md | none | sm
hideTitleboolean
paddingBottomstring | number
paddingTopstring | number | IndexFrameSteps
presetstring
sidebarobject
Show child parameters
dividerobject
docobjectrequired
gapstring | number
phonestring | object
positionstringrequired
left | none | right
sourcestring
doc | docs-nav
startAfternumber
widthstring
default | narrow | wide
widthnumber | string
homeDocrequired
homeDocTranslationsobject
lanesobject[]required
Show child parameters
itemsReaderItem[]required
Show child parameters
answerCountnumber
answerPostIdstringrequired
authorAvatarSeedstring
authorAvatarUrlstring
authorIdstringrequired
authorKindstring
anonymous | guest | member | persona | service | staged
authorNamestringrequired
authorPointsnumber
authorTitlestring
authorUsernamestring
bookmarkedboolean
bylineBylinerequired
bylinesBylineView[]
categoryIdstringrequired
commentsEnabledbooleanrequired
coverUrlstringrequired
customizationPieceCustomizationrequired
deletedAtstring
excerptstringrequired
expiresAtstring
featuredbooleanrequired
featuredLinkstringrequired
fieldsobjectrequired
firstImageUrlstring
furtherReadingobject[]required
idstringrequired
importancenumber
isNewboolean
kindstringrequired
ARTICLE | DISCUSSION | FEATURE | QUESTION | RELEASE
lastActivityAtstringrequired
lastPostedAtstring
lastPosterNamestring
likeCountnumber
listedbooleanrequired
mergedIntoIdstringrequired
numbernumberrequired
onThisPagestringrequired
always | auto | never
pinnedbooleanrequired
pinnedGloballybooleanrequired
pinnedUntilstringrequired
postersForumPoster[]
promotedPageIdstringrequired
publishedAtstringrequired
readingMinutesnumberrequired
releaseVersionstringrequired
replyCountnumberrequired
replyPreviewsReplyPreview[]
reviewobject
roadmapStatusstringrequired
scheduledForstringrequired
seriesstringrequired
shippedTopicIdsstring[]required
slugstringrequired
statestringrequired
ARCHIVED | CLOSED | DRAFT | PUBLISHED
statusstringrequired
archived | closed | draft | published
subtitlestring
tagInfoTagDisplay[]
tagsstring[]required
titlestringrequired
unreadnumber
updatedAtstringrequired
viewCountnumberrequired
voteCountnumberrequired
votedbooleanrequired
statusstringrequired
presetstringrequired
roadmapstringrequired
statusLabelsobjectrequired
voteModestringrequired
binary | importance
{
  "anonymousVotes": true,
  "facets": {
    "tags": [
      {
        "count": 0,
        "tag": "string"
      }
    ],
    "themes": [
      "string"
    ]
  },
  "filters": {
    "mine": true,
    "q": "string",
    "sort": "new",
    "status": "string",
    "tag": "string"
  },
  "following": true,
  "frontDoor": {},
  "frontPage": {
    "aside": {
      "doc": {
        "content": null,
        "type": null
      },
      "phone": "after",
      "width": "default"
    },
    "customization": {},
    "doc": {
      "content": [
        null
      ],
      "type": "doc"
    },
    "gap": "lg",
    "hideTitle": true,
    "paddingBottom": "string",
    "paddingTop": "string",
    "preset": "string",
    "sidebar": {
      "divider": {
        "color": null,
        "style": null,
        "width": null
      },
      "doc": {
        "content": null,
        "type": null
      },
      "gap": null,
      "phone": null,
      "position": "left",
      "source": "doc",
      "startAfter": 0,
      "width": "default"
    },
    "width": 0
  },
  "homeDoc": {},
  "homeDocTranslations": {},
  "lanes": [
    {
      "items": [
        {
          "answerCount": null,
          "answerPostId": null,
          "authorAvatarSeed": null,
          "authorAvatarUrl": null,
          "authorId": null,
          "authorKind": null,
          "authorName": null,
          "authorPoints": null,
          "authorTitle": null,
          "authorUsername": null,
          "bookmarked": null,
          "byline": null,
          "bylines": null,
          "categoryId": null,
          "commentsEnabled": null,
          "coverUrl": null,
          "customization": null,
          "deletedAt": null,
          "excerpt": null,
          "expiresAt": null,
          "featured": null,
          "featuredLink": null,
          "fields": null,
          "firstImageUrl": null,
          "furtherReading": null,
          "id": null,
          "importance": null,
          "isNew": null,
          "kind": null,
          "lastActivityAt": null,
          "lastPostedAt": null,
          "lastPosterName": null,
          "likeCount": null,
          "listed": null,
          "mergedIntoId": null,
          "number": null,
          "onThisPage": null,
          "pinned": null,
          "pinnedGlobally": null,
          "pinnedUntil": null,
          "posters": null,
          "promotedPageId": null,
          "publishedAt": null,
          "readingMinutes": null,
          "releaseVersion": null,
          "replyCount": null,
          "replyPreviews": null,
          "review": null,
          "roadmapStatus": null,
          "scheduledFor": null,
          "series": null,
          "shippedTopicIds": null,
          "slug": null,
          "state": null,
          "status": null,
          "subtitle": null,
          "tagInfo": null,
          "tags": null,
          "title": null,
          "unread": null,
          "updatedAt": null,
          "viewCount": null,
          "voteCount": null,
          "voted": null
        }
      ],
      "status": "SUBMITTED"
    }
  ],
  "preset": "string",
  "roadmap": "string",
  "statusLabels": {},
  "voteMode": "binary"
}
Option 2
anonymousVotesbooleanrequired
facetsobjectrequired
Show child parameters
tagsobject[]required
Show child parameters
countnumberrequired
tagstringrequired
themesstring[]required
filtersobjectrequired
Show child parameters
minebooleanrequired
qstringrequired
sortstringrequired
new | top | trending
statusstringrequired
tagstringrequired
followingboolean
frontDoorobjectrequired
frontPageStoredFrontPagerequired
Show child parameters
asideobject
Show child parameters
docobjectrequired
phonestring
after | hide
widthstring
default | narrow | wide
customizationobject
docobjectrequired
Show child parameters
contentobject[]required
typestringrequired
doc
gapstring
lg | md | none | sm
hideTitleboolean
paddingBottomstring | number
paddingTopstring | number | IndexFrameSteps
presetstring
sidebarobject
Show child parameters
dividerobject
docobjectrequired
gapstring | number
phonestring | object
positionstringrequired
left | none | right
sourcestring
doc | docs-nav
startAfternumber
widthstring
default | narrow | wide
widthnumber | string
homeDocrequired
homeDocTranslationsobject
lanesobject[]required
Show child parameters
itemsReaderItem[]required
Show child parameters
answerCountnumber
answerPostIdstringrequired
authorAvatarSeedstring
authorAvatarUrlstring
authorIdstringrequired
authorKindstring
anonymous | guest | member | persona | service | staged
authorNamestringrequired
authorPointsnumber
authorTitlestring
authorUsernamestring
bookmarkedboolean
bylineBylinerequired
bylinesBylineView[]
categoryIdstringrequired
commentsEnabledbooleanrequired
coverUrlstringrequired
customizationPieceCustomizationrequired
deletedAtstring
excerptstringrequired
expiresAtstring
featuredbooleanrequired
featuredLinkstringrequired
fieldsobjectrequired
firstImageUrlstring
furtherReadingobject[]required
idstringrequired
importancenumber
isNewboolean
kindstringrequired
ARTICLE | DISCUSSION | FEATURE | QUESTION | RELEASE
lastActivityAtstringrequired
lastPostedAtstring
lastPosterNamestring
likeCountnumber
listedbooleanrequired
mergedIntoIdstringrequired
numbernumberrequired
onThisPagestringrequired
always | auto | never
pinnedbooleanrequired
pinnedGloballybooleanrequired
pinnedUntilstringrequired
postersForumPoster[]
promotedPageIdstringrequired
publishedAtstringrequired
readingMinutesnumberrequired
releaseVersionstringrequired
replyCountnumberrequired
replyPreviewsReplyPreview[]
{
  "anonymousVotes": true,
  "facets": {
    "tags": [
      {
        "count": 0,
        "tag": "string"
      }
    ],
    "themes": [
      "string"
    ]
  },
  "filters": {
    "mine": true,
    "q": "string",
    "sort": "new",
    "status": "string",
    "tag": "string"
  },
  "following": true,
  "frontDoor": {},
  "frontPage": {
    "aside": {
      "doc": {
        "content": null,
        "type": null
      },
      "phone": "after",
      "width": "default"
    },
    "customization": {},
    "doc": {
      "content": [
        null
      ],
      "type": "doc"
    },
    "gap": "lg",
    "hideTitle": true,
    "paddingBottom": "string",
    "paddingTop": "string",
    "preset": "string",
    "sidebar": {
      "divider": {
        "color": null,
        "style": null,
        "width": null
      },
      "doc": {
        "content": null,
        "type": null
      },
      "gap": null,
      "phone": null,
      "position": "left",
      "source": "doc",
      "startAfter": 0,
      "width": "default"
    },
    "width": 0
  },
  "homeDoc": {},
  "homeDocTranslations": {},
  "lanes": [
    {
      "items": [
        {
          "answerCount": null,
          "answerPostId": null,
          "authorAvatarSeed": null,
          "authorAvatarUrl": null,
          "authorId": null,
          "authorKind": null,
          "authorName": null,
          "authorPoints": null,
          "authorTitle": null,
          "authorUsername": null,
          "bookmarked": null,
          "byline": null,
          "bylines": null,
          "categoryId": null,
          "commentsEnabled": null,
          "coverUrl": null,
          "customization": null,
          "deletedAt": null,
          "excerpt": null,
          "expiresAt": null,
          "featured": null,
          "featuredLink": null,
          "fields": null,
          "firstImageUrl": null,
          "furtherReading": null,
          "id": null,
          "importance": null,
          "isNew": null,
          "kind": null,
          "lastActivityAt": null,
          "lastPostedAt": null,
          "lastPosterName": null,
          "likeCount": null,
          "listed": null,
          "mergedIntoId": null,
          "number": null,
          "onThisPage": null,
          "pinned": null,
          "pinnedGlobally": null,
          "pinnedUntil": null,
          "posters": null,
          "promotedPageId": null,
          "publishedAt": null,
          "readingMinutes": null,
          "releaseVersion": null,
          "replyCount": null,
          "replyPreviews": null,
          "review": null,
          "roadmapStatus": null,
          "scheduledFor": null,
          "series": null,
          "shippedTopicIds": null,
          "slug": null,
          "state": null,
          "status": null,
          "subtitle": null,
          "tagInfo": null,
          "tags": null,
          "title": null,
          "unread": null,
          "updatedAt": null,
          "viewCount": null,
          "voteCount": null,
          "voted": null
        }
      ],
      "status": "SUBMITTED"
    }
  ],
  "page": {
    "limit": 0,
    "hasMore": true,
    "nextCursor": "string",
    "has_more": true,
    "next_cursor": "string",
    "total": 0
  },
  "preset": "string",
  "roadmap": "string",
  "statusLabels": {},
  "voteMode": "binary",
  "data": [
    {
      "items": [
        {
          "answerCount": null,
          "answerPostId": null,
          "authorAvatarSeed": null,
          "authorAvatarUrl": null,
          "authorId": null,
          "authorKind": null,
          "authorName": null,
          "authorPoints": null,
          "authorTitle": null,
          "authorUsername": null,
          "bookmarked": null,
          "byline": null,
          "bylines": null,
          "categoryId": null,
          "commentsEnabled": null,
          "coverUrl": null,
          "customization": null,
          "deletedAt": null,
          "excerpt": null,
          "expiresAt": null,
          "featured": null,
          "featuredLink": null,
          "fields": null,
          "firstImageUrl": null,
          "furtherReading": null,
          "id": null,
          "importance": null,
          "isNew": null,
          "kind": null,
          "lastActivityAt": null,
          "lastPostedAt": null,
          "lastPosterName": null,
          "likeCount": null,
          "listed": null,
          "mergedIntoId": null,
          "number": null,
          "onThisPage": null,
          "pinned": null,
          "pinnedGlobally": null,
          "pinnedUntil": null,
          "posters": null,
          "promotedPageId": null,
          "publishedAt": null,
          "readingMinutes": null,
          "releaseVersion": null,
          "replyCount": null,
          "replyPreviews": null,
          "review": null,
          "roadmapStatus": null,
          "scheduledFor": null,
          "series": null,
          "shippedTopicIds": null,
          "slug": null,
          "state": null,
          "status": null,
          "subtitle": null,
          "tagInfo": null,
          "tags": null,
          "title": null,
          "unread": null,
          "updatedAt": null,
          "viewCount": null,
          "voteCount": null,
          "voted": null
        }
      ],
      "status": "SUBMITTED"
    }
  ]
}
400 The request could not be understood — a malformed header, path or query value (request.malformed). A value that was understood but is not acceptable is a 422 validation.failed.
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
404 No such thing — one of the ids in the path does not resolve, or resolves to something this caller may not see (*.not_found).
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
429 Rate limited — see the RateLimit-* headers.
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
default Error — the stable { error: { code, message } } envelope.
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
The Forumulate teamUpdated