Skip to main content
GET
List the caller's knowledge scopes
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/scopes/list lists the calling credential’s own knowledge scopes. It needs knowledge:read. The readable and writable sets are exactly the ones every knowledge route enforces for this credential (see Scope resolution), so a client can pick a scopeType and scopeId, or a source target, before it calls. MCP hosts call it with forge_list_knowledge_scopes. Each item is { namespace, scopeType, entityId, label, readable, writable }: the namespace parsed into its scope type and entity (entityId is null for company and global), the entity’s name when one resolves (label, else null), and whether the credential may read and write it. Every scope is returned, in one response without limit, or in pages of limit with cursor. A credential that resolves no scope answers an empty list. The scopes resolve from the credential, never from the request. The route takes no query parameter but limit and cursor; any other answers 400 bad_request.

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

limit
integer

Items per page, 1 to 1000; a larger value is a 400 too_big. Omitted, the page is the whole list. The list is read whole.

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

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

Minimum string length: 1

Response

The caller's knowledge scopes

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.