Knowledge
GET
/api/v1/workspaces/{workspaceId}/knowledge/{scope}/pages/tree
Scope knowledge:read
Get the page tree for a knowledge scope. Use internal for the in-app wiki. Pass a locale, and set includeUntranslated to keep pages that have no translation in that language.
Pfad
scopePflicht
string
Knowledge scope, for example internal or a public site.
workspaceIdPflicht
string
Workspace that owns the resource.
Query
locale
string
Language code of the page.
includeUntranslated
boolean
When true, include pages that have no translation in the requested locale.
Antworten
200KnowledgePageTreeNodeDto[]The request succeeded. The JSON body contains url, data, and meta. The linked schema is data.
Knowledge page tree node.
id
string (uuid)
Identifier.
parentPageId
string (uuid)
Identifier of the parent page.
title
string
Title.
slug
string
Stable slug used in paths and API calls.
status
hasUnpublishedChanges
boolean
Whether unpublished changes is set.
sortOrder
integer (int32)
Order among siblings. Lower numbers come first.
depth
integer (int32)
Depth.
locale
string
Language code.
translationGroupId
string (uuid)
Identifier of the translation group.
isTranslated
boolean
Whether this is translated.
createdAt
string (date-time)
When this was created.
updatedAt
string (date-time)
When this was last updated.
publishedAt
string (date-time)
When the published was recorded.
createdByUserId
string (uuid)
Member who created this.
apiRefKind
apiRefKey
string
API ref key.
children
KnowledgePageTreeNodeDto[]
Children.