Get the category

Embed
Preview of the card
<a href="https://forumulate.com/reference/forumulate-api-publicforumcategory-category"><img src="https://forumulate.com/reference/_api/public/orgs/046a9bc0-d530-43ae-9bae-af7945008cda/spaces/8042f004-e3d9-445f-b7a4-b6c1f86836e6/pages/40c98a22-ec6e-4a2d-9200-9ccc83bee85a/social-card.svg?v=3e7ae33eec8b" alt="Get the category" width="600" height="315"></a>
GEThttps://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/forum/category/{slug}

One category as a page: its summary, stats over it and its subcategories, its parent and children, its "about" topic and — signed in — the reader’s follow level. Unknown and hidden from this reader are the same 404, so the address confirms nothing.

Parameters
orgIdstringpathrequired
spaceIdstringpathrequired
slugstringpathrequired
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}/forum/category/{slug}" \
  -H "forumulate-version: <value>"
TypeScript
const res = await fetch('https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/forum/category/{slug}', {
  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}/forum/category/{slug}",
    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}/forum/category/{slug}", 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}/forum/category/{slug}');
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}/forum/category/{slug}')
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}/forum/category/{slug}"))
    .header("forumulate-version", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Success.
Example
{
  "category": {
    "aboutTopic": {
      "excerpt": "string",
      "slug": "string",
      "title": "string"
    },
    "aboutTopicId": "string",
    "allowedTags": [
      "string"
    ],
    "autoCloseHours": 0,
    "backgroundUrl": "string",
    "children": [
      {
        "aboutTopicId": null,
        "allowedTags": [
          null
        ],
        "autoCloseHours": null,
        "backgroundUrl": null,
        "color": null,
        "colorDark": null,
        "defaultListFilter": null,
        "defaultNotificationLevel": "string",
        "defaultSlowModeSeconds": null,
        "defaultSort": null,
        "defaultTags": [
          null
        ],
        "defaultTopPeriod": null,
        "description": "string",
        "emoji": null,
        "formTemplateId": null,
        "icon": null,
        "id": "string",
        "latest": null,
        "logoUrl": null,
        "minimumRequiredTags": 0,
        "name": "string",
        "navigateToFirstPost": null,
        "numFeaturedTopics": null,
        "parentId": null,
        "requiredTagGroups": [
          null
        ],
        "restricted": true,
        "showSubcategoryList": true,
        "slug": "string",
        "sortAscending": null,
        "sortOrder": 0,
        "style": null,
        "subcategoryListStyle": null,
        "textColor": null,
        "textColorDark": null,
        "topicCount": 0,
        "topicKind": "discussion",
        "topicTemplate": null,
        "totalTopicCount": 0,
        "translations": {}
      }
    ],
    "color": "string",
    "colorDark": "string",
    "defaultListFilter": "string",
    "defaultNotificationLevel": "string",
    "defaultSlowModeSeconds": 0,
    "defaultSort": "string",
    "defaultTags": [
      "string"
    ],
    "defaultTopPeriod": "string",
    "description": "string",
    "emoji": "string",
    "formTemplateId": "string",
    "icon": "string",
    "id": "string",
    "logoUrl": "string",
    "minimumRequiredTags": 0,
    "name": "string",
    "navigateToFirstPost": true,
    "numFeaturedTopics": 0,
    "parent": {
      "color": null,
      "id": "string",
      "name": "string",
      "slug": "string",
      "translations": {}
    },
    "parentId": "string",
    "replyCount": 0,
    "requiredTagGroups": [
      {
        "minCount": 0,
        "tagGroupId": "string"
      }
    ],
    "restricted": true,
    "showSubcategoryList": true,
    "slug": "string",
    "sortAscending": true,
    "sortOrder": 0,
    "style": "string",
    "subcategoryListStyle": "string",
    "textColor": "string",
    "textColorDark": "string",
    "topicCount": 0,
    "topicKind": "discussion",
    "topicsThisWeek": 0,
    "topicTemplate": {},
    "totalTopicCount": 0,
    "translations": {},
    "viewerLevel": "string"
  }
}
Schema
categoryobjectrequired
Show child parameters
aboutTopicobjectrequired
Show child parameters
excerptstringrequired
slugstringrequired
titlestringrequired
aboutTopicIdstringrequired
allowedTagsstring[]required
autoCloseHoursnumberrequired
backgroundUrlstringrequired
childrenobject[]required
Show child parameters
aboutTopicIdstringrequired
allowedTagsstring[]required
autoCloseHoursnumberrequired
backgroundUrlstringrequired
colorstringrequired
colorDarkstringrequired
defaultListFilterstringrequired
defaultNotificationLevelstringrequired
defaultSlowModeSecondsnumberrequired
defaultSortstringrequired
defaultTagsstring[]required
defaultTopPeriodstringrequired
descriptionstringrequired
emojistringrequired
formTemplateIdstringrequired
iconstringrequired
idstringrequired
latestobjectrequired
logoUrlstringrequired
minimumRequiredTagsnumberrequired
namestringrequired
navigateToFirstPostbooleanrequired
numFeaturedTopicsnumberrequired
parentIdstringrequired
requiredTagGroupsRequiredTagGroup[]required
restrictedbooleanrequired
showSubcategoryListbooleanrequired
slugstringrequired
sortAscendingbooleanrequired
sortOrdernumberrequired
stylestringrequired
subcategoryListStylestringrequired
textColorstringrequired
textColorDarkstringrequired
topicCountnumberrequired
topicKindstringrequired
discussion | question
topicTemplateobjectrequired
totalTopicCountnumberrequired
translationsobjectrequired
colorstringrequired
colorDarkstringrequired
defaultListFilterstringrequired
defaultNotificationLevelstringrequired
defaultSlowModeSecondsnumberrequired
defaultSortstringrequired
defaultTagsstring[]required
defaultTopPeriodstringrequired
descriptionstringrequired
emojistringrequired
formTemplateIdstringrequired
iconstringrequired
idstringrequired
logoUrlstringrequired
minimumRequiredTagsnumberrequired
namestringrequired
navigateToFirstPostbooleanrequired
numFeaturedTopicsnumberrequired
parentobjectrequired
Show child parameters
colorstringrequired
idstringrequired
namestringrequired
slugstringrequired
translationsobjectrequired
parentIdstringrequired
replyCountnumberrequired
requiredTagGroupsRequiredTagGroup[]required
Show child parameters
minCountnumberrequired
tagGroupIdstringrequired
restrictedbooleanrequired
showSubcategoryListbooleanrequired
slugstringrequired
sortAscendingbooleanrequired
sortOrdernumberrequired
stylestringrequired
subcategoryListStylestringrequired
textColorstringrequired
textColorDarkstringrequired
topicCountnumberrequired
topicKindstringrequired
discussion | question
topicsThisWeeknumberrequired
topicTemplateobjectrequired
totalTopicCountnumberrequired
translationsobjectrequired
viewerLevelstring
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.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
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).
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
429 Rate limited — see the RateLimit-* headers.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
default Error — the stable { error: { code, message } } envelope.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
The Forumulate teamUpdated