GEgetaptly
Knowledge

Get a knowledge document

Returns a knowledge document's full detail — folder path, shares, direct children, links to any board/card/conversation, view counts, and content rendered as HTML.

currentUser is populated only when authenticated with a delegate token (its userId is known); it is null for API keys and partner tokens, which are company-wide credentials with no per-user permission check. A private document you cannot view returns 404, the same as one that doesn't exist. Unlike list/tree/ children, this is a direct by-id fetch, so an archived document is still returned (with archived: true) rather than 404ing.

get/api/knowledge/{id}

Request

Path parameters

idstring required

The knowledge document ID.

Response

Knowledge document detail.

_idstring

Document ID.

namestring

Document title.

emojistring nullable
iconUrlstring nullable
coverUrlstring nullable
accessType'public' | 'publicReadonly' | 'private'
isPrivateboolean
parentIdstring nullable
childCountinteger
publishedboolean
publishedAtstring date-time nullable
archivedboolean
archivedAtstring date-time nullable
createdAtstring date-time nullable
createdBystring nullable
updatedAtstring date-time nullable
updatedBystring nullable
htmlstring

Document body rendered as HTML. Aptly custom blocks and inline items appear as elements with data-content-type / data-inline-content-type and data-* property attributes, plus a readable label — see "HTML format" in PUT /api/knowledge/{id}.

Changes

No recorded changes to this operation across all 1 revision of this API.