Skip to main content
GET
List knowledge subject collections
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/knowledge/subjectCollections/list lists the subject collections in the credential’s readable namespaces, or in the one namespace names. A subject collection records what a prose artifact is about; it never grants or narrows access. MCP hosts call it through forge_call_operation with operationId listKnowledgeSubjectCollections. It needs knowledge:read. A collection is listed only where the caller reads knowledge; for a Personal key, that means where its owner reads knowledge. A namespace the caller cannot read answers 403 forbidden, recorded. The response is { data: { status, collections }, meta }. Each collection carries its collectionId, namespace, name, an optional parentCollectionId, and artifactCount. The count includes only the filed artifacts the caller can read. It never counts:
  • a record;
  • an artifact waiting for review;
  • a source-restricted artifact.
List one collection’s artifacts with List knowledge cases and its collectionId. The read is bounded:
  • artifactCountIsPartial: true marks a count that stopped at the read budget; that count is then a floor.
  • status: "too_large" means a namespace holds more collections than one read loads.
  • meta.partial is true in either case.
Creating a subject collection and filing an artifact in one stay in the Console.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

namespace
string

One readable namespace from scopes/list; a namespace the caller cannot read is a recorded 403.

Minimum string length: 1
limit
integer
default:50

Items per page, 1 to 100 (default 50); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 100
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

One page of subject collections

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.