Get the blog in a space (public reader)
GET
https://forumulate.com/api /public/orgs/{orgId}/spaces/{spaceId}/blog The published posts of a blog, newest first, as a visitor sees them. For an index page, a "latest from our blog" strip on a marketing site, or a feed reader. ?locale= lists each post under its published translation in that language, with locale and locales.
Parameters
orgIdstringpathrequiredspaceIdstringpathrequiredlimitintegerqueryArticles per page. Defaults to 20. 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.
tagstringqueryauthorIdstringqueryauthorstringqueryseriesstringquerymonthstringquerypageintegerqueryWhich page of results to return, 1-based. Out-of-range pages return an empty list.
cursorstringquerysharestringquerypinnedstringqueryUse true or false (true/1/yes/on and false/0/no/off are accepted).
featuredstringqueryUse true or false (true/1/yes/on and false/0/no/off are accepted).
previewstringquerytagsstringquerytagMatchstringqueryexcludestring[]queryComma-separated post ids to leave out — a front page’s feeds de-duplicating each other.
offsetintegerquerySkip this many posts before the page starts (added to the page’s own offset).
localestringquerysortstringqueryforumulate-versionstringheaderAPI 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}/blog?limit=&tag=&authorId=&author=&series=&month=&page=&cursor=&share=&pinned=&featured=&preview=&tags=&tagMatch=&exclude=&offset=&locale=&sort=" \
-H "forumulate-version: <value>"TypeScript
const res = await fetch('https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/blog?limit=&tag=&authorId=&author=&series=&month=&page=&cursor=&share=&pinned=&featured=&preview=&tags=&tagMatch=&exclude=&offset=&locale=&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}/blog?limit=&tag=&authorId=&author=&series=&month=&page=&cursor=&share=&pinned=&featured=&preview=&tags=&tagMatch=&exclude=&offset=&locale=&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}/blog?limit=&tag=&authorId=&author=&series=&month=&page=&cursor=&share=&pinned=&featured=&preview=&tags=&tagMatch=&exclude=&offset=&locale=&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}/blog?limit=&tag=&authorId=&author=&series=&month=&page=&cursor=&share=&pinned=&featured=&preview=&tags=&tagMatch=&exclude=&offset=&locale=&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}/blog?limit=&tag=&authorId=&author=&series=&month=&page=&cursor=&share=&pinned=&featured=&preview=&tags=&tagMatch=&exclude=&offset=&locale=&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.bodyJava
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}/blog?limit=&tag=&authorId=&author=&series=&month=&page=&cursor=&share=&pinned=&featured=&preview=&tags=&tagMatch=&exclude=&offset=&locale=&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
{
"articles": [
{
"answerCount": 0,
"answerPostId": null,
"authorAvatarSeed": "string",
"authorAvatarUrl": "string",
"authorId": null,
"authorKind": "anonymous",
"authorName": null,
"authorPoints": 0,
"authorTitle": "string",
"authorUsername": "string",
"bookmarked": true,
"byline": null,
"bylines": [
null
],
"categoryId": null,
"commentsEnabled": true,
"coverUrl": null,
"customization": null,
"deletedAt": "2024-01-01T00:00:00Z",
"excerpt": "string",
"expiresAt": "2024-01-01T00:00:00Z",
"featured": true,
"featuredLink": null,
"firstImageUrl": "string",
"furtherReading": [
null
],
"id": "string",
"isNew": true,
"kind": "ARTICLE",
"lastActivityAt": "2024-01-01T00:00:00Z",
"lastPostedAt": "string",
"lastPosterName": "string",
"likeCount": 0,
"listed": true,
"mergedIntoId": null,
"number": null,
"onThisPage": "always",
"pinned": true,
"pinnedGlobally": true,
"pinnedUntil": null,
"posters": [
null
],
"promotedPageId": null,
"publishedAt": null,
"readingMinutes": 0,
"releaseVersion": null,
"replyCount": 0,
"replyPreviews": [
null
],
"review": {
"note": null,
"requestedAt": null,
"requestedBy": null,
"reviewedAt": null,
"reviewedBy": null,
"state": null
},
"roadmapStatus": null,
"scheduledFor": null,
"series": null,
"shippedTopicIds": [
null
],
"slug": "string",
"state": "ARCHIVED",
"status": "archived",
"subtitle": "string",
"tagInfo": [
null
],
"tags": [
null
],
"title": "string",
"unread": 0,
"updatedAt": "2024-01-01T00:00:00Z",
"viewCount": 0,
"voteCount": 0
}
],
"blog": "string",
"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": {},
"locale": "string",
"locales": [
{
"available": true,
"code": "string",
"isDefault": true,
"label": "string"
}
],
"preset": "string"
}Option 1
articlesArticleSummary[]requiredShow child parameters
answerCountnumberanswerPostIdstringrequiredauthorAvatarSeedstringauthorAvatarUrlstringauthorIdstringrequiredauthorKindstringauthorNamestringrequiredauthorPointsnumberauthorTitlestringauthorUsernamestringbookmarkedbooleanbylineBylinerequiredShow child parameters
avatarUrlstringnamestringurlstringbylinesBylineView[]Show child parameters
authorstringrequiredavatarUrlstringrequiredbiostringrequiredhandlestringnamestringrequiredrolestringrequiredurlstringrequireduserIdstringrequiredcategoryIdstringrequiredcommentsEnabledbooleanrequiredcoverUrlstringrequiredcustomizationPieceCustomizationrequiredShow child parameters
customCssstringjsonLdstringogDescriptionstringogTitlestringshareImageUrlstringthemeobjecttwitterCardstringdeletedAtstringexcerptstringrequiredexpiresAtstringfeaturedbooleanrequiredfeaturedLinkstringrequiredfirstImageUrlstringfurtherReadingobject[]requiredShow child parameters
hrefstringrequiredlabelstringrequiredidstringrequiredisNewbooleankindstringrequiredlastActivityAtstringrequiredlastPostedAtstringlastPosterNamestringlikeCountnumberlistedbooleanrequiredmergedIntoIdstringrequirednumbernumberrequiredonThisPagestringrequiredpinnedbooleanrequiredpinnedGloballybooleanrequiredpinnedUntilstringrequiredpostersForumPoster[]Show child parameters
avatarSeedstringrequiredavatarUrlstringrequiredkindstringrequirednamestringrequiredrolestringrequiredusernamestringrequiredpromotedPageIdstringrequiredpublishedAtstringrequiredreadingMinutesnumberrequiredreleaseVersionstringrequiredreplyCountnumberrequiredreplyPreviewsReplyPreview[]Show child parameters
authorstringrequiredauthorAvatarstringrequiredauthorSeedstringrequiredtextstringrequiredreviewobjectShow child parameters
notestringrequiredrequestedAtstringrequiredrequestedBystringrequiredreviewedAtstringrequiredreviewedBystringrequiredstatestringrequiredroadmapStatusstringrequiredscheduledForstringrequiredseriesstringrequiredshippedTopicIdsstring[]requiredslugstringrequiredstatestringrequiredstatusstringrequiredsubtitlestringtagInfoTagDisplay[]Show child parameters
colorstringrequiredcolorDarkstringrequiredcoverUrlstringrequireddescriptionstringrequiredgradientarrayrequirediconstringlabelstringrequiredpagePaletteobjectrequiredpageSchemestringrequiredslugstringrequiredtextColorstringrequiredtextColorDarkstringrequiredtagsstring[]requiredtitlestringrequiredunreadnumberupdatedAtstringrequiredviewCountnumberrequiredvoteCountnumberrequiredblogstringrequiredfrontDoorobjectrequiredfrontPageStoredFrontPagerequiredShow child parameters
asideobjectShow child parameters
docobjectrequiredphonestringwidthstringcustomizationobjectdocobjectrequiredShow child parameters
contentobject[]requiredtypestringrequiredgapstringhideTitlebooleanpaddingBottomstring | numberpaddingTopstring | number | IndexFrameStepspresetstringsidebarobjectShow child parameters
dividerobjectdocobjectrequiredgapstring | numberphonestring | objectpositionstringrequiredsourcestringstartAfternumberwidthstringwidthnumber | stringhomeDocrequiredhomeDocTranslationsobjectlocalestringlocalesReleaseLocaleLink[]Show child parameters
availablebooleanrequiredcodestringrequiredisDefaultbooleanrequiredlabelstringrequiredpresetstringrequired{
"articles": [
{
"answerCount": 0,
"answerPostId": "string",
"authorAvatarSeed": "string",
"authorAvatarUrl": "string",
"authorId": "string",
"authorKind": "anonymous",
"authorName": "string",
"authorPoints": 0,
"authorTitle": "string",
"authorUsername": "string",
"bookmarked": true,
"byline": {
"avatarUrl": null,
"name": null,
"url": null
},
"bylines": [
{
"author": null,
"avatarUrl": null,
"bio": null,
"handle": null,
"name": null,
"role": null,
"url": null,
"userId": null
}
],
"categoryId": "string",
"commentsEnabled": true,
"coverUrl": "string",
"customization": {
"customCss": null,
"jsonLd": null,
"ogDescription": null,
"ogTitle": null,
"shareImageUrl": null,
"theme": null,
"twitterCard": null
},
"deletedAt": "2024-01-01T00:00:00Z",
"excerpt": "string",
"expiresAt": "2024-01-01T00:00:00Z",
"featured": true,
"featuredLink": "string",
"firstImageUrl": "string",
"furtherReading": [
{
"href": null,
"label": null
}
],
"id": "string",
"isNew": true,
"kind": "ARTICLE",
"lastActivityAt": "2024-01-01T00:00:00Z",
"lastPostedAt": "string",
"lastPosterName": "string",
"likeCount": 0,
"listed": true,
"mergedIntoId": "string",
"number": 0,
"onThisPage": "always",
"pinned": true,
"pinnedGlobally": true,
"pinnedUntil": "2024-01-01T00:00:00Z",
"posters": [
{
"avatarSeed": null,
"avatarUrl": null,
"kind": null,
"name": null,
"role": null,
"username": null
}
],
"promotedPageId": "string",
"publishedAt": "2024-01-01T00:00:00Z",
"readingMinutes": 0,
"releaseVersion": "string",
"replyCount": 0,
"replyPreviews": [
{
"author": null,
"authorAvatar": null,
"authorSeed": null,
"text": null
}
],
"review": {
"note": null,
"requestedAt": null,
"requestedBy": null,
"reviewedAt": null,
"reviewedBy": null,
"state": "approved"
},
"roadmapStatus": "string",
"scheduledFor": "2024-01-01T00:00:00Z",
"series": "string",
"shippedTopicIds": [
"string"
],
"slug": "string",
"state": "ARCHIVED",
"status": "archived",
"subtitle": "string",
"tagInfo": [
{
"color": null,
"colorDark": null,
"coverUrl": null,
"description": null,
"gradient": null,
"icon": null,
"label": null,
"pagePalette": null,
"pageScheme": null,
"slug": null,
"textColor": null,
"textColorDark": null
}
],
"tags": [
"string"
],
"title": "string",
"unread": 0,
"updatedAt": "2024-01-01T00:00:00Z",
"viewCount": 0,
"voteCount": 0
}
],
"blog": "string",
"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": {},
"locale": "string",
"locales": [
{
"available": true,
"code": "string",
"isDefault": true,
"label": "string"
}
],
"preset": "string"
}Option 2
articlesArticleSummary[]requiredShow child parameters
answerCountnumberanswerPostIdstringrequiredauthorAvatarSeedstringauthorAvatarUrlstringauthorIdstringrequiredauthorKindstringauthorNamestringrequiredauthorPointsnumberauthorTitlestringauthorUsernamestringbookmarkedbooleanbylineBylinerequiredShow child parameters
avatarUrlstringnamestringurlstringbylinesBylineView[]Show child parameters
authorstringrequiredavatarUrlstringrequiredbiostringrequiredhandlestringnamestringrequiredrolestringrequiredurlstringrequireduserIdstringrequiredcategoryIdstringrequiredcommentsEnabledbooleanrequiredcoverUrlstringrequiredcustomizationPieceCustomizationrequiredShow child parameters
customCssstringjsonLdstringogDescriptionstringogTitlestringshareImageUrlstringthemeobjecttwitterCardstringdeletedAtstringexcerptstringrequiredexpiresAtstringfeaturedbooleanrequiredfeaturedLinkstringrequiredfirstImageUrlstringfurtherReadingobject[]requiredShow child parameters
hrefstringrequiredlabelstringrequiredidstringrequiredisNewbooleankindstringrequiredlastActivityAtstringrequiredlastPostedAtstringlastPosterNamestringlikeCountnumberlistedbooleanrequiredmergedIntoIdstringrequirednumbernumberrequired400 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