v10

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-0582185581.9 KB
Knowledge Base
Knowledge Hub

Get knowledge hub child nodes

Returns the children of a specific node in the knowledge hub tree. Use this endpoint to drill down into Collections, connector app hierarchies, folders, and record groups.

Navigation hierarchy

The typical drill-down path is:

  1. Root apps (GET /knowledgeBase/knowledge-hub/nodes)
  2. Record groups / folders within an app (parentType=app)
  3. Records within a record group (parentType=recordGroup)
  4. Sub-records or attachments within a record (parentType=record)

Parent identification

  • parentType must be one of: app, recordGroup, folder, record
  • parentId is either a standard UUID or the Collection app sentinel knowledgeBase_<orgId> (e.g. knowledgeBase_org123)

Filtering and searching

All query-param filters from the root endpoint are available here and operate within the scope of the parent node's subtree. When q is provided, the search spans all descendants of the parent node.

Response extras

When include=breadcrumbs is set, the response contains a breadcrumbs array tracing the path from the root to the current node. The currentNode and parentNode objects are always populated for non-root requests.

Access control

Requires a valid bearer token. For OAuth tokens the kb:read scope must be present; regular JWT bearer tokens pass through without scope enforcement.

get/knowledgeBase/knowledge-hub/nodes/{parentType}/{parentId}

Path parameters

parentType'app' | 'recordGroup' | 'folder' | 'record' required

Type of the parent node whose children to retrieve.

Must be one of: app, recordGroup, folder, record. Any other value returns a 400 error.

parentIdstring required

Identifier of the parent node. Accepts two formats:

  • A standard UUID (e.g. f3a4b5b6-5b6c-4e85-9097-3202cfe696fc)
  • The Collection app sentinel knowledgeBase_<orgId> (e.g. knowledgeBase_org123)

Any value that does not match either format returns a 400 error.

Query parameters

onlyContainersboolean

When true, only nodes that have children are returned (useful for building sidebar / tree navigation). Leaf nodes are excluded.

pageinteger

Page number (1-indexed). Combined with limit to paginate results.

limitinteger

Maximum number of items to return per page.

sortBy'name' | 'createdAt' | 'updatedAt' | 'size' | 'type'

Field to sort results by. Omitted → default updatedAt. Unknown value → silently falls back to name.

sortOrder'asc' | 'desc'

Sort direction. Omitted → default desc. Unknown value → silently falls back to asc.

qstring

Full-text search query. Must be between 2 and 500 characters (inclusive). When provided, the endpoint searches across all descendants of the parent node.

nodeTypesstring

Comma-separated list of node types to include. Invalid values are silently ignored. Maximum 100 items.

Valid values: folder, app, recordGroup, record

recordTypesstring

Comma-separated list of record types to include. Invalid values are silently ignored. Maximum 100 items.

Valid values: FILE, DRIVE, WEBPAGE, DATABASE, DATASOURCE, MESSAGE, MAIL, GROUP_MAIL, TICKET, COMMENT, INLINE_COMMENT, CONFLUENCE_PAGE, CONFLUENCE_BLOGPOST, SHAREPOINT_PAGE, SHAREPOINT_LIST, SHAREPOINT_LIST_ITEM, SHAREPOINT_DOCUMENT_LIBRARY, LINK, PROJECT, PULL_REQUEST, MEETING, PRODUCT, DEAL, CASE, TASK, ARTIFACT, CODE_FILE, SQL_TABLE, SQL_VIEW, OTHERS

originsstring

Comma-separated list of origin types to include. Invalid values are silently ignored. Maximum 100 items.

Valid values: COLLECTION, CONNECTOR

connectorIdsstring

Comma-separated list of connector instance IDs (UUIDs) to filter by. Maximum 100 items. No enum validation — any string is accepted, but non-existent IDs simply yield zero results.

indexingStatusstring

Comma-separated list of indexing statuses to include. Invalid values are silently ignored. Maximum 100 items.

Valid values: NOT_STARTED, PAUSED, IN_PROGRESS, COMPLETED, FAILED, FILE_TYPE_NOT_SUPPORTED, AUTO_INDEX_OFF, EMPTY, ENABLE_MULTIMODAL_MODELS, QUEUED

createdAtstring

Created-date range filter. Format: gte:<epochMs>,lte:<epochMs>. Both bounds are optional (you may send just gte:... or just lte:...). Timestamps must be in the range 0 to 9999999999999 and gte must be less than or equal to lte when both are present.

updatedAtstring

Updated-date range filter. Same format and constraints as createdAt.

sizestring

File-size range filter in bytes. Format: gte:<bytes>,lte:<bytes>. Both bounds are optional. Values must be non-negative and at most 1099511627776 (1 TB). gte must be less than or equal to lte when both are present.

includestring

Comma-separated list of additional response sections to include. Invalid values are silently ignored. Maximum 100 items.

Valid values: breadcrumbs, counts, availableFilters, permissions

Response

Paginated children of {parentType}/{parentId}. HTTP 200 returns success: true and error: null; see KnowledgeHubNodesResponse for the full shape.

id and currentNode reflect the parent being browsed; parentNode is set when a grandparent exists. Optional sections (availableFilters, counts, permissions, breadcrumbs) are JSON null unless listed in include and populated by the server.

successtrue required

Always true on HTTP 200. Failures use 4xx/5xx error envelopes, not this body shape.

errorstring nullable required

Always null on HTTP 200.

idstring nullable required

Current parent node ID when browsing children; null at root.