Get the forum in a space

Embed

<a href="https://forumulate.com/reference/forumulate-api-forum-list"><img src="https://forumulate.com/reference/_api/public/orgs/046a9bc0-d530-43ae-9bae-af7945008cda/spaces/8042f004-e3d9-445f-b7a4-b6c1f86836e6/pages/6c5b251b-3153-4f5a-aceb-8a205024bcb0/social-card.svg?v=3e7ae33eec8b" alt="Get the forum in a space" width="600" height="315"></a>

GEThttps://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/forum

The forum as a staff member sees it: its categories, its pinned and recent topics, and the counts a moderation view needs. The same roots the public door serves, plus what is hidden from readers — unlisted categories, topics awaiting approval, and anything deleted but recoverable.

Requires token scope: read (the coarse method gate) for Atlas key (ak_), Personal Access Token (cft_) or OAuth (cfo_) auth — in addition to any catalog scope (GET /pats/scopes) the route’s capability needs. Session/cookie auth is governed by RBAC capabilities instead.

Parameters

orgIdstringpathrequired

spaceIdstringpathrequired

limitintegerquery

Topics per page. Defaults to 30. 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.

= 30

tagstringquery

qstringquery

categorystringquery

includeSubcategoriesstringquery

Use true or false (true/1/yes/on and false/0/no/off are accepted).

true | 1 | yes | on | false | 0 | no | off

pageintegerquery

Which page of results to return, 1-based. Out-of-range pages return an empty list.

= 1

assignedstringquery

cursorstringquery

kindstringquery

QUESTION | DISCUSSION

sortstringquery

latest | top

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/orgs/{orgId}/spaces/{spaceId}/forum?limit=&tag=&q=&category=&includeSubcategories=&page=&assigned=&cursor=&kind=&sort=" \
  -H "forumulate-version: <value>"

TypeScript

const res = await fetch('https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/forum?limit=&tag=&q=&category=&includeSubcategories=&page=&assigned=&cursor=&kind=&sort=', {
  method: 'GET',
  headers: {
    'forumulate-version': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/forum?limit=&tag=&q=&category=&includeSubcategories=&page=&assigned=&cursor=&kind=&sort=",
    headers={
    "forumulate-version": "<value>",
    },
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/forum?limit=&tag=&q=&category=&includeSubcategories=&page=&assigned=&cursor=&kind=&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/orgs/{orgId}/spaces/{spaceId}/forum?limit=&tag=&q=&category=&includeSubcategories=&page=&assigned=&cursor=&kind=&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/orgs/{orgId}/spaces/{spaceId}/forum?limit=&tag=&q=&category=&includeSubcategories=&page=&assigned=&cursor=&kind=&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/orgs/{orgId}/spaces/{spaceId}/forum?limit=&tag=&q=&category=&includeSubcategories=&page=&assigned=&cursor=&kind=&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

{
  "hasMore": true,
  "page": 0,
  "pageSize": 0,
  "topics": [
    {
      "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
    }
  ],
  "unread": {}
}

ForumListLegacy

hasMorebooleanrequired

pagenumberrequired

pageSizenumberrequired

topicsArticleSummary[]required

Show child parameters

answerCountnumber

answerPostIdstringrequired

authorAvatarSeedstring

authorAvatarUrlstring

authorIdstringrequired

authorKindstring

authorNamestringrequired

authorPointsnumber

authorTitlestring

authorUsernamestring

bookmarkedboolean

bylineBylinerequired

Show child parameters

avatarUrlstring

namestring

urlstring

bylinesBylineView[]

Show child parameters

authorstringrequired

avatarUrlstringrequired

biostringrequired

handlestring

namestringrequired

rolestringrequired

urlstringrequired

userIdstringrequired

categoryIdstringrequired

commentsEnabledbooleanrequired

coverUrlstringrequired

customizationPieceCustomizationrequired

Show child parameters

customCssstring

jsonLdstring

ogDescriptionstring

ogTitlestring

shareImageUrlstring

themeobject

twitterCardstring

summary | summary_large_image

deletedAtstring

excerptstringrequired

expiresAtstring

featuredbooleanrequired

featuredLinkstringrequired

firstImageUrlstring

furtherReadingobject[]required

Show child parameters

hrefstringrequired

labelstringrequired

idstringrequired

isNewboolean

kindstringrequired

ARTICLE | DISCUSSION | FEATURE | QUESTION | RELEASE

lastActivityAtstringrequired

lastPostedAtstring

lastPosterNamestring

likeCountnumber

listedbooleanrequired

mergedIntoIdstringrequired

numbernumberrequired

onThisPagestringrequired

always | auto | never

pinnedbooleanrequired

pinnedGloballybooleanrequired

pinnedUntilstringrequired

postersForumPoster[]

Show child parameters

avatarSeedstringrequired

avatarUrlstringrequired

kindstringrequired

namestringrequired

rolestringrequired

frequent | latest | op

usernamestringrequired

promotedPageIdstringrequired

publishedAtstringrequired

readingMinutesnumberrequired

releaseVersionstringrequired

replyCountnumberrequired

replyPreviewsReplyPreview[]

Show child parameters

authorstringrequired

authorAvatarstringrequired

authorSeedstringrequired

textstringrequired

reviewobject

Show child parameters

notestringrequired

requestedAtstringrequired

requestedBystringrequired

reviewedAtstringrequired

reviewedBystringrequired

statestringrequired

approved | changes_requested | in_review

roadmapStatusstringrequired

scheduledForstringrequired

seriesstringrequired

shippedTopicIdsstring[]required

slugstringrequired

statestringrequired

ARCHIVED | CLOSED | DRAFT | PUBLISHED

statusstringrequired

archived | closed | draft | published

subtitlestring

tagInfoTagDisplay[]

Show child parameters

colorstringrequired

colorDarkstringrequired

coverUrlstringrequired

descriptionstringrequired

gradientarrayrequired

iconstring

labelstringrequired

pagePaletteobjectrequired

pageSchemestringrequired

dark | light

slugstringrequired

textColorstringrequired

textColorDarkstringrequired

tagsstring[]required

titlestringrequired

unreadnumber

updatedAtstringrequired

viewCountnumberrequired

voteCountnumberrequired

unreadobjectrequired

{
  "hasMore": true,
  "page": 0,
  "pageSize": 0,
  "topics": [
    {
      "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
    }
  ],
  "unread": {}
}

ForumListEnveloped

pageobjectrequired

The paging envelope a collection carries when the caller states Forumulate-Version. Each operation’s own response schema says whether it has one: a collection either carries page, or answers both this and its pre-envelope shape and picks by the header. No listing pages with keys of its own any more — the allowlists in openapi-collection-shape.test.ts are empty, which is what stops a new one from appearing. Read hasMore and nextCursor: the snake_case pair beside them is deprecated and is not sent to a caller who states 2026-11-01 or later.

Show child parameters

limitintegerrequired

The limit this page was built with — what was asked for, capped. NOT the number of rows returned: a final page under the limit is normal, and hasMore is the only thing that says whether to keep walking.

hasMorebooleanrequired

Whether another page follows this one.

nextCursorstringrequired

Pass back as cursor to continue. Null on the last page.

has_morebooleandeprecated

The same value as hasMore. These two are the only snake_case keys in the API. Sent to callers who state 2026-09-01 or no version at all; ABSENT from 2026-11-01 onwards. Read hasMore instead — it is sent on every version.

next_cursorstringdeprecated

The same value as nextCursor. Absent from 2026-11-01 onwards; read nextCursor.

totalinteger

Rows in the whole collection — the size of the set, not of this page, and not of what you have seen so far. ABSENT where the source cannot count the collection: the append-only logs (staff actions, automation runs, connector activity, ingested questions, chat history) grow without bound and are not counted on every page view. Walk on hasMore, which is exact on every answer; read total only to show a size, and handle its absence.

topicsArticleSummary[]required

Show child parameters

answerCountnumber

answerPostIdstringrequired

authorAvatarSeedstring

authorAvatarUrlstring

authorIdstringrequired

authorKindstring

authorNamestringrequired

authorPointsnumber

authorTitlestring

authorUsernamestring

bookmarkedboolean

bylineBylinerequired

Show child parameters

avatarUrlstring

namestring

urlstring

bylinesBylineView[]

Show child parameters

authorstringrequired

avatarUrlstringrequired

biostringrequired

handlestring

namestringrequired

rolestringrequired

urlstringrequired

userIdstringrequired

categoryIdstringrequired

commentsEnabledbooleanrequired

coverUrlstringrequired

customizationPieceCustomizationrequired

Show child parameters

customCssstring

jsonLdstring

ogDescriptionstring

ogTitlestring

shareImageUrlstring

themeobject

twitterCardstring

summary | summary_large_image

deletedAtstring

excerptstringrequired

expiresAtstring

featuredbooleanrequired

featuredLinkstringrequired

firstImageUrlstring

furtherReadingobject[]required

Show child parameters

hrefstringrequired

labelstringrequired

idstringrequired

isNewboolean

kindstringrequired

ARTICLE | DISCUSSION | FEATURE | QUESTION | RELEASE

lastActivityAtstringrequired

lastPostedAtstring

lastPosterNamestring

likeCountnumber

listedbooleanrequired

mergedIntoIdstringrequired

numbernumberrequired

onThisPagestringrequired

always | auto | never

pinnedbooleanrequired

pinnedGloballybooleanrequired

pinnedUntilstringrequired

postersForumPoster[]

Show child parameters

avatarSeedstringrequired

avatarUrlstringrequired

kindstringrequired

namestringrequired

rolestringrequired

frequent | latest | op

usernamestringrequired

promotedPageIdstringrequired

publishedAtstringrequired

readingMinutesnumberrequired

releaseVersionstringrequired

replyCountnumberrequired

replyPreviewsReplyPreview[]

Show child parameters

authorstringrequired

authorAvatarstringrequired

authorSeedstringrequired

textstringrequired

reviewobject

Show child parameters

notestringrequired

requestedAtstringrequired

{
  "page": {
    "limit": 0,
    "hasMore": true,
    "nextCursor": "string",
    "has_more": true,
    "next_cursor": "string",
    "total": 0
  },
  "topics": [
    {
      "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
    }
  ],
  "unread": {},
  "data": [
    {
      "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
    }
  ]
}

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"
}

401 No credential, or one that is expired or revoked (auth.required). Send a Bearer token or the session cookie.

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

403 Authenticated, and not allowed — always rbac.forbidden, whether what is missing is the capability, the token scope, or a resource the token is pinned away from. The message names the capability and, for a scope refusal, the scopes that would grant it. A refusal because of the PLAN is a 402 with quota.exceeded, not this.

{
  "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 Oct 17, 2026

Was this page helpful?