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}
Get a knowledge document
curl --request GET \ --url https://core-api.getaptly.com/api/knowledge/{id} \ --header 'x-token: <api-key>'
Null for API key / partner token callers — those credentials are company-wide, so no per-user permission check is applied. Populated only for a delegate token, where the caller's own user identity is known.
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}.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Aptly API","colors":{"primary":"#0066FF"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"aptly-10a57313","hasAudioNarration":false,"actualSubdomain":"aptly-10a57313","customDomains":["docs.getaptly.com"],"gitSource":{"type":"github","owner":"workturbo","repo":"core-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4dfc987cb31e1fa2cb0ab","collectionId":"1788173d-2862-4418-873a-da2b64e83176","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4dfc987cb31e1fa2cb0ab"},"feedback":{"agentFeedback":true},"entitlements":{},"buildId":"6ae4dfc987cb31e1fa2cb0ab","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":192},{"language":"default","tag":"Board","count":28},{"language":"default","tag":"Documentation","count":17},{"language":"default","tag":"Aptly Portal","count":14},{"language":"default","tag":"Contacts","count":10},{"language":"default","tag":"Cards","count":9},{"language":"default","tag":"Knowledge","count":8},{"language":"default","tag":"Getting Started","count":7},{"language":"default","tag":"Inboxes","count":7},{"language":"default","tag":"Context \u0026 Locations","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/knowledge/get-a-knowledge-document","slug":"/api-reference/knowledge/get-a-knowledge-document","pageMetadata":{"title":"Get a knowledge document","description":"Returns a knowledge document's full detail — folder path, shares, direct children,\nlinks to any board/card/conversation, view counts, and content rendered as HTML.\n\n`currentUser` is populated only when authenticated with a delegate token (its\n`userId` is known); it is `null` for API keys and partner tokens, which are\ncompany-wide credentials with no per-user permission check. A private document you\ncannot view returns 404, the same as one that doesn't exist. Unlike `list`/`tree`/\n`children`, this is a direct by-id fetch, so an archived document is still\nreturned (with `archived: true`) rather than 404ing.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}","href":"/api-reference/knowledge/get-a-knowledge-document","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns a knowledge document’s full detail — folder path, shares, direct children,\\nlinks to any board/card/conversation, view counts, and content rendered as HTML.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"currentUser\"\n }), \" is populated only when authenticated with a delegate token (its\\n\", _jsx(_components.code, {\n children: \"userId\"\n }), \" is known); it is \", _jsx(_components.code, {\n children: \"null\"\n }), \" for API keys and partner tokens, which are\\ncompany-wide credentials with no per-user permission check. A private document you\\ncannot view returns 404, the same as one that doesn’t exist. Unlike \", _jsx(_components.code, {\n children: \"list\"\n }), \"/\", _jsx(_components.code, {\n children: \"tree\"\n }), \"/\\n\", _jsx(_components.code, {\n children: \"children\"\n }), \", this is a direct by-id fetch, so an archived document is still\\nreturned (with \", _jsx(_components.code, {\n children: \"archived: true\"\n }), \") rather than 404ing.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a knowledge document","description":"Returns a knowledge document's full detail — folder path, shares, direct children,\nlinks to any board/card/conversation, view counts, and content rendered as HTML.\n\n`currentUser` is populated only when authenticated with a delegate token (its\n`userId` is known); it is `null` for API keys and partner tokens, which are\ncompany-wide credentials with no per-user permission check. A private document you\ncannot view returns 404, the same as one that doesn't exist. Unlike `list`/`tree`/\n`children`, this is a direct by-id fetch, so an archived document is still\nreturned (with `archived: true`) rather than 404ing.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}","href":"/api-reference/knowledge/get-a-knowledge-document","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get a knowledge document","description":"Returns a knowledge document's full detail — folder path, shares, direct children,\nlinks to any board/card/conversation, view counts, and content rendered as HTML.\n\n`currentUser` is populated only when authenticated with a delegate token (its\n`userId` is known); it is `null` for API keys and partner tokens, which are\ncompany-wide credentials with no per-user permission check. A private document you\ncannot view returns 404, the same as one that doesn't exist. Unlike `list`/`tree`/\n`children`, this is a direct by-id fetch, so an archived document is still\nreturned (with `archived: true`) rather than 404ing.\n","operationId":"getKnowledgeDoc","tags":["Knowledge"],"security":["41e83412-1030-4f9d-bbfa-7a5d69a5c388","e934e940-6366-40d3-9161-db73679b872e","f46c0a10-6e6b-4e52-afdc-22ed11709b9c"],"parameters":["9292c991-719a-4c0e-aed9-6cbd78af55fd"],"responses":{"200":"78a60fac-f532-4fe6-94b8-932a339fe52e","401":"0f08e34d-3d33-448e-a465-f9472f2f740c","404":"7e38bc55-fe72-472d-90a0-5758e4a4f1c6"},"method":"get","type":"path","servers":["07b42306-8584-4b68-93b8-f52adbaae2fe"],"path":"/api/knowledge/{id}","baseUrlOptions":["https://core-api.getaptly.com"],"title":"Get a knowledge document","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9292c991-719a-4c0e-aed9-6cbd78af55fd":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The knowledge document ID.","uniqueKey":"","typeLabel":"string"},"description":"The knowledge document ID."}},"responses":{"78a60fac-f532-4fe6-94b8-932a339fe52e":{"description":"Knowledge document detail.","content":{"application/json":{"schema":{"type":"object","description":"Full document detail returned by GET /api/knowledge/{id}.","properties":{"_id":{"type":"string","description":"Document ID.","uniqueKey":"_id","typeLabel":"string"},"name":{"type":"string","description":"Document title.","uniqueKey":"name","typeLabel":"string"},"emoji":{"oneOf":[{"type":"string","uniqueKey":"emoji.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"emoji.oneOf.1","typeLabel":"null"}],"uniqueKey":"emoji","typeLabel":"string | null"},"iconUrl":{"oneOf":[{"type":"string","uniqueKey":"iconUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"iconUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"iconUrl","typeLabel":"string | null"},"coverUrl":{"oneOf":[{"type":"string","uniqueKey":"coverUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"coverUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"coverUrl","typeLabel":"string | null"},"accessType":{"type":"string","enum":["public","publicReadonly","private"],"uniqueKey":"accessType","typeLabel":"enum\u003cstring>"},"isPrivate":{"type":"boolean","uniqueKey":"isPrivate","typeLabel":"boolean"},"shares":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"shares.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","enum":["user","team"],"uniqueKey":"shares.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"permission":{"type":"string","enum":["edit","comment","view"],"uniqueKey":"shares.items.[INDEX].permission","typeLabel":"enum\u003cstring>"},"owner":{"type":"boolean","uniqueKey":"shares.items.[INDEX].owner","typeLabel":"boolean"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"shares.items.[INDEX].createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"shares.items.[INDEX].createdAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"shares.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time> | null"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"shares.items.[INDEX].updatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"shares.items.[INDEX].updatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"shares.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"shares.items.[INDEX]","typeLabel":"object"},"uniqueKey":"shares","typeLabel":"object[]"},"parentId":{"oneOf":[{"type":"string","uniqueKey":"parentId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"parentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"parentId","typeLabel":"string | null"},"path":{"type":"array","description":"Root-first ancestor chain (folders above this document). Excludes this document.","items":{"type":"object","properties":{"_id":{"type":"string","uniqueKey":"path.items.[INDEX]._id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"path.items.[INDEX].name","typeLabel":"string"},"emoji":{"oneOf":[{"type":"string","uniqueKey":"path.items.[INDEX].emoji.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"path.items.[INDEX].emoji.oneOf.1","typeLabel":"null"}],"uniqueKey":"path.items.[INDEX].emoji","typeLabel":"string | null"}},"uniqueKey":"path.items.[INDEX]","typeLabel":"object"},"uniqueKey":"path","typeLabel":"object[]"},"children":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","uniqueKey":"children.items.[INDEX]._id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"children.items.[INDEX].name","typeLabel":"string"},"emoji":{"oneOf":[{"type":"string","uniqueKey":"children.items.[INDEX].emoji.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"children.items.[INDEX].emoji.oneOf.1","typeLabel":"null"}],"uniqueKey":"children.items.[INDEX].emoji","typeLabel":"string | null"},"rank":{"oneOf":[{"type":"integer","uniqueKey":"children.items.[INDEX].rank.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"children.items.[INDEX].rank.oneOf.1","typeLabel":"null"}],"uniqueKey":"children.items.[INDEX].rank","typeLabel":"integer | null"}},"uniqueKey":"children.items.[INDEX]","typeLabel":"object"},"uniqueKey":"children","typeLabel":"object[]"},"childCount":{"type":"integer","uniqueKey":"childCount","typeLabel":"integer"},"links":{"type":"object","properties":{"aptletUuid":{"oneOf":[{"type":"string","uniqueKey":"links.aptletUuid.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"links.aptletUuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.aptletUuid","typeLabel":"string | null"},"aptletInstanceId":{"oneOf":[{"type":"string","uniqueKey":"links.aptletInstanceId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"links.aptletInstanceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.aptletInstanceId","typeLabel":"string | null"},"streamId":{"oneOf":[{"type":"string","uniqueKey":"links.streamId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"links.streamId.oneOf.1","typeLabel":"null"}],"uniqueKey":"links.streamId","typeLabel":"string | null"}},"uniqueKey":"links","typeLabel":"object"},"published":{"type":"boolean","uniqueKey":"published","typeLabel":"boolean"},"publishedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"publishedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"publishedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"publishedAt","typeLabel":"string\u003cdate-time> | null"},"views":{"type":"object","properties":{"internal":{"type":"integer","uniqueKey":"views.internal","typeLabel":"integer"},"public":{"type":"integer","uniqueKey":"views.public","typeLabel":"integer"}},"uniqueKey":"views","typeLabel":"object"},"archived":{"type":"boolean","uniqueKey":"archived","typeLabel":"boolean"},"archivedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"archivedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"archivedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"archivedAt","typeLabel":"string\u003cdate-time> | null"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"createdAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time> | null"},"createdBy":{"oneOf":[{"type":"string","uniqueKey":"createdBy.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"createdBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdBy","typeLabel":"string | null"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"updatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"updatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time> | null"},"updatedBy":{"oneOf":[{"type":"string","uniqueKey":"updatedBy.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"updatedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"updatedBy","typeLabel":"string | null"},"currentUser":{"oneOf":[{"type":"object","description":"Null for API key / partner token callers — those credentials are company-wide, so no per-user permission check is applied. Populated only for a delegate token, where the caller's own user identity is known.\n","properties":{"userId":{"type":"string","uniqueKey":"currentUser.oneOf.0.userId","typeLabel":"string"},"isOwner":{"type":"boolean","uniqueKey":"currentUser.oneOf.0.isOwner","typeLabel":"boolean"},"permission":{"oneOf":[{"type":"string","enum":["edit","comment","view",null],"uniqueKey":"currentUser.oneOf.0.permission.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["edit","comment","view",null],"uniqueKey":"currentUser.oneOf.0.permission.oneOf.1","typeLabel":"null"}],"uniqueKey":"currentUser.oneOf.0.permission","typeLabel":"enum\u003cstring> | null"},"canView":{"type":"boolean","uniqueKey":"currentUser.oneOf.0.canView","typeLabel":"boolean"},"canEdit":{"type":"boolean","uniqueKey":"currentUser.oneOf.0.canEdit","typeLabel":"boolean"},"canComment":{"type":"boolean","uniqueKey":"currentUser.oneOf.0.canComment","typeLabel":"boolean"}},"uniqueKey":"currentUser.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null for API key / partner token callers — those credentials are company-wide, so no per-user permission check is applied. Populated only for a delegate token, where the caller's own user identity is known.\n","properties":{"userId":{"type":"string"},"isOwner":{"type":"boolean"},"permission":{"oneOf":[{"type":"string","enum":["edit","comment","view",null]},{"type":"null","enum":["edit","comment","view",null]}]},"canView":{"type":"boolean"},"canEdit":{"type":"boolean"},"canComment":{"type":"boolean"}},"uniqueKey":"currentUser.oneOf.1","typeLabel":"null"}],"uniqueKey":"currentUser","typeLabel":"object | null"},"html":{"type":"string","description":"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}`.","uniqueKey":"html","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"_id":"kdoc_abc123","name":"Lease Addendum Policy","emoji":null,"iconUrl":null,"coverUrl":null,"accessType":"public","isPrivate":false,"shares":[],"parentId":null,"path":[],"children":[],"childCount":0,"links":{"aptletUuid":null,"aptletInstanceId":null,"streamId":null},"published":false,"publishedAt":null,"views":{"internal":0,"public":0},"archived":false,"archivedAt":null,"createdAt":"2026-01-05T12:00:00.000Z","createdBy":"user_123","updatedAt":"2026-01-05T12:00:00.000Z","updatedBy":"user_123","currentUser":null,"html":"\u003cp>This policy applies to all lease agreements...\u003c/p>"},"examples":{"Example":{"title":"Example","value":{"_id":"kdoc_abc123","name":"Lease Addendum Policy","emoji":null,"iconUrl":null,"coverUrl":null,"accessType":"public","isPrivate":false,"shares":[],"parentId":null,"path":[],"children":[],"childCount":0,"links":{"aptletUuid":null,"aptletInstanceId":null,"streamId":null},"published":false,"publishedAt":null,"views":{"internal":0,"public":0},"archived":false,"archivedAt":null,"createdAt":"2026-01-05T12:00:00.000Z","createdBy":"user_123","updatedAt":"2026-01-05T12:00:00.000Z","updatedBy":"user_123","currentUser":null,"html":"\u003cp>This policy applies to all lease agreements...\u003c/p>"}}},"exampleType":"examples"}},"exampleType":"examples"},"0f08e34d-3d33-448e-a465-f9472f2f740c":{"description":"Invalid or missing API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7e38bc55-fe72-472d-90a0-5758e4a4f1c6":{"description":"Document not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"41e83412-1030-4f9d-bbfa-7a5d69a5c388":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"x-token","scopes":[],"schemeName":"ApiKeyHeader"}},"e934e940-6366-40d3-9161-db73679b872e":{"DelegateToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Delegate token issued by the platform. Format: `DelegateToken \u003ctoken>`","scopes":[],"schemeName":"DelegateToken"}},"f46c0a10-6e6b-4e52-afdc-22ed11709b9c":{"PartnerBearer":{"type":"http","scheme":"bearer","description":"Partner token. Format: `Authorization: Bearer \u003ctoken>`","scopes":[],"schemeName":"PartnerBearer"}}},"servers":{"07b42306-8584-4b68-93b8-f52adbaae2fe":{"url":"https://core-api.getaptly.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-token","scopes":[],"schemeName":"ApiKeyHeader"},"schema":{"title":"x-token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyHeader","name":"x-token"}],"title":"ApiKeyHeader"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Delegate token issued by the platform. Format: `DelegateToken \u003ctoken>`","scopes":[],"schemeName":"DelegateToken"},"schema":{"title":"Authorization","type":"string","description":"Delegate token issued by the platform. Format: `DelegateToken \u003ctoken>`","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"DelegateToken","name":"Authorization"}],"title":"DelegateToken"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Partner token. Format: `Authorization: Bearer \u003ctoken>`","scopes":[],"schemeName":"PartnerBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Partner token. Format: `Authorization: Bearer \u003ctoken>`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"PartnerBearer","name":"Authorization"}],"title":"PartnerBearer"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"aptly-10a57313","siteName":"Aptly API","title":"Get a knowledge document - Aptly API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T18:20:14.477Z","originalFileLocation":"api-reference/knowledge/get-a-knowledge-document.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a knowledge document\u0026#x27;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\u0026#x27;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.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aptly API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a knowledge document - Aptly API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a knowledge document\u0026#x27;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\u0026#x27;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.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aptly API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://aptly-10a57313.mintlify.app/_mintlify/api/og/v2?division=Knowledge\u0026amp;title=Get+a+knowledge+document\u0026amp;description=Returns+a+knowledge+document%27s+full+detail+%E2%80%94+folder+path%2C+shares%2C+direct+children%2C%0Alinks+to+any+board%2Fcard%2Fconversation%2C+view+counts%2C+and+content+rendered+as+HT\u0026amp;theme=2df7969a14dd47f616338bb6\u0026amp;signature=dcabd8246f260a7ef1731bdc2923200f96fc95e67332d48a264bfade91f370e6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a knowledge document - Aptly API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a knowledge document\u0026#x27;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\u0026#x27;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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://aptly-10a57313.mintlify.app/_mintlify/api/og/v2?division=Knowledge\u0026amp;title=Get+a+knowledge+document\u0026amp;description=Returns+a+knowledge+document%27s+full+detail+%E2%80%94+folder+path%2C+shares%2C+direct+children%2C%0Alinks+to+any+board%2Fcard%2Fconversation%2C+view+counts%2C+and+content+rendered+as+HT\u0026amp;theme=2df7969a14dd47f616338bb6\u0026amp;signature=dcabd8246f260a7ef1731bdc2923200f96fc95e67332d48a264bfade91f370e6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aptly API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/knowledge/get-a-knowledge-document.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getaptly.com/#organization\",\"name\":\"Aptly API\",\"url\":\"https://docs.getaptly.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getaptly.com#website\",\"name\":\"Aptly API\",\"url\":\"https://docs.getaptly.com\",\"publisher\":{\"@id\":\"https://docs.getaptly.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document#webpage\",\"url\":\"https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document\",\"name\":\"Get a knowledge document\",\"description\":\"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.\",\"dateModified\":\"2026-10-30T18:20:14.477Z\",\"isPartOf\":{\"@id\":\"https://docs.getaptly.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.getaptly.com/api-reference/users/list-users\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Knowledge\",\"item\":\"https://docs.getaptly.com/api-reference/knowledge/create-a-knowledge-document\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a knowledge document\",\"item\":\"https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document#apireference\",\"headline\":\"Get a knowledge document\",\"name\":\"Get a knowledge document\",\"description\":\"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.\",\"url\":\"https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document#webpage\"},\"dateModified\":\"2026-10-30T18:20:14.477Z\",\"publisher\":{\"@id\":\"https://docs.getaptly.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getaptly.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aptly API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Aptly API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/users","href":"/api-reference/users/list-users"},{"title":"List a user's email inboxes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/users/{userId}/inboxes","href":"/api-reference/users/list-a-users-email-inboxes"}]},{"group":"Inboxes","pages":[{"title":"List inboxes you can query","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes","href":"/api-reference/inboxes/list-inboxes-you-can-query"},{"title":"List threads and messages on an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/messages","href":"/api-reference/inboxes/list-threads-and-messages-on-an-inbox"},{"title":"Conversation analytics for an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/analytics","href":"/api-reference/inboxes/conversation-analytics-for-an-inbox"},{"title":"Activity history for an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/history","href":"/api-reference/inboxes/activity-history-for-an-inbox"},{"title":"Volume and response-time trends for an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/trends","href":"/api-reference/inboxes/volume-and-response-time-trends-for-an-inbox"},{"title":"Volume health for an inbox against its own baseline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/health","href":"/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline"},{"title":"List unsent drafts on an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/drafts","href":"/api-reference/inboxes/list-unsent-drafts-on-an-inbox"}]},{"group":"Schema","pages":[{"title":"Get board schema","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/schema/{boardId}","href":"/api-reference/schema/get-board-schema"}]},{"group":"Boards","pages":[{"title":"List boards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/boards","href":"/api-reference/boards/list-boards"},{"title":"Create a board","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/boards","href":"/api-reference/boards/create-a-board"}]},{"group":"Cards","pages":[{"title":"List cards","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/list","href":"/api-reference/cards/list-cards"},{"title":"List cards (deprecated)","deprecated":true,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}","href":"/api-reference/cards/list-cards-deprecated"},{"title":"Create or update a card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}","href":"/api-reference/cards/create-or-update-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/{cardId}","href":"/api-reference/cards/get-a-card"},{"title":"Archive a card","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}/{cardId}","href":"/api-reference/cards/archive-a-card"},{"title":"List comments on a card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/{cardId}/comments","href":"/api-reference/cards/list-comments-on-a-card"},{"title":"List contacts linked to a card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/{cardId}/contacts","href":"/api-reference/cards/list-contacts-linked-to-a-card"},{"title":"Add or update a comment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/{cardId}/comment","href":"/api-reference/cards/add-or-update-a-comment"},{"title":"Upload a file to a card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/{cardId}/file","href":"/api-reference/cards/upload-a-file-to-a-card"}]},{"group":"Board","pages":[{"title":"Archive a board","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}","href":"/api-reference/board/archive-a-board"},{"title":"List merge fields for a board","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/merge-fields","href":"/api-reference/board/list-merge-fields-for-a-board"},{"title":"List users who can open a board","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/users","href":"/api-reference/board/list-users-who-can-open-a-board"},{"title":"Add a tab view","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/tabViews","href":"/api-reference/board/add-a-tab-view"},{"title":"Add a tab view (legacy)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/tabView","href":"/api-reference/board/add-a-tab-view-legacy"},{"title":"Verify a delegate token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/verify-user","href":"/api-reference/board/verify-a-delegate-token"},{"title":"Set or update the board's webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/webhook","href":"/api-reference/board/set-or-update-the-boards-webhook"},{"title":"Remove the board's webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}/webhook","href":"/api-reference/board/remove-the-boards-webhook"},{"title":"Get full board configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration","href":"/api-reference/board/get-full-board-configuration"},{"title":"List board automations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/automations","href":"/api-reference/board/list-board-automations"},{"title":"Create an automation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/automations","href":"/api-reference/board/create-an-automation"},{"title":"List create-card rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/card-rules","href":"/api-reference/board/list-create-card-rules"},{"title":"Get board options","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/options","href":"/api-reference/board/get-board-options"},{"title":"List board fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/fields","href":"/api-reference/board/list-board-fields"},{"title":"Add a field","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/fields","href":"/api-reference/board/add-a-field"},{"title":"Add a mirror field","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/mirror-fields","href":"/api-reference/board/add-a-mirror-field"},{"title":"Update a field","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/fields/{fieldUuid}","href":"/api-reference/board/update-a-field"},{"title":"Delete a field","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}/configuration/fields/{fieldUuid}","href":"/api-reference/board/delete-a-field"},{"title":"Reorder fields","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/field-order","href":"/api-reference/board/reorder-fields"},{"title":"List board field groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/groups","href":"/api-reference/board/list-board-field-groups"},{"title":"Create a field group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/groups","href":"/api-reference/board/create-a-field-group"},{"title":"Update a field group","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/groups/{groupUuid}","href":"/api-reference/board/update-a-field-group"},{"title":"Get the create-card form order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/start-card-order","href":"/api-reference/board/get-the-create-card-form-order"},{"title":"Set the create-card form order","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/start-card-order","href":"/api-reference/board/set-the-create-card-form-order"},{"title":"Get board access settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/shares","href":"/api-reference/board/get-board-access-settings"},{"title":"Get board identity fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/theme","href":"/api-reference/board/get-board-identity-fields"},{"title":"Update board identity fields","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/board/{boardId}/configuration/theme","href":"/api-reference/board/update-board-identity-fields"},{"title":"List board filters","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/filters","href":"/api-reference/board/list-board-filters"}]},{"group":"Company","pages":[{"title":"Get company info","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/company/info","href":"/api-reference/company/get-company-info"}]},{"group":"Contacts","pages":[{"title":"Get conversations for contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/conversations","href":"/api-reference/contacts/get-conversations-for-contacts"},{"title":"Get contact conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts/{contactId}/conversations","href":"/api-reference/contacts/get-contact-conversations"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create or update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts","href":"/api-reference/contacts/create-or-update-a-contact"},{"title":"Look up contacts by email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/by-email","href":"/api-reference/contacts/look-up-contacts-by-email"},{"title":"Initiate contact email verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/verify-email","href":"/api-reference/contacts/initiate-contact-email-verification"},{"title":"Confirm contact email verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/verify-email/{requestId}/confirm","href":"/api-reference/contacts/confirm-contact-email-verification"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts/{contactId}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/{contactId}","href":"/api-reference/contacts/update-a-contact"},{"title":"Get a contact's sentiment history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts/{contactId}/sentiment","href":"/api-reference/contacts/get-a-contacts-sentiment-history"}]},{"group":"Knowledge","pages":[{"title":"Create a knowledge document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/knowledge/create","href":"/api-reference/knowledge/create-a-knowledge-document"},{"title":"List knowledge documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/list","href":"/api-reference/knowledge/list-knowledge-documents"},{"title":"Get the knowledge document tree","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/tree","href":"/api-reference/knowledge/get-the-knowledge-document-tree"},{"title":"List a knowledge document's direct children","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}/children","href":"/api-reference/knowledge/list-a-knowledge-documents-direct-children"},{"title":"List saved knowledge document versions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}/history","href":"/api-reference/knowledge/list-saved-knowledge-document-versions"},{"title":"Read a saved knowledge document version","description":"Reads retained saved snapshots of a non-archived knowledge document. Partner tokens require knowledge-docs; API keys or delegate tokens use knowledge read access. Delegate callers must remain active company members and currently be able to view the document; membership, document and team authorization use primary reads. API keys and partner tokens are company-scoped. Archived, deleted, or inaccessible documents return 404. There is no archived override. Snapshots older than the current document creation time are excluded so a reused document ID cannot expose a deleted document history. These are saved versions, not unsaved drafts or a complete edit audit: rapid saves may merge and older history may be pruned (normally 50 versions retained). savedBy records the saver, not necessarily the author of every passage; Hiro before/after snapshots both name the approver. No restore or mutation is performed. Returns historical metadata and read-only top-level text blocks, up to 20 blocks and 20,000 text characters per page. Each block is capped at 10,000 characters with explicit truncation; specialized blocks may omit non-text/formatting details. offset/nextOffset count blocks. No editable flags or current editing-version token are returned. Unsupported legacy snapshots return 400. The top-level name is the current title; snapshot.name is the historical title. Any document link opens the current document.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}/history/{versionId}","href":"/api-reference/knowledge/read-a-saved-knowledge-document-version"},{"title":"Get a knowledge document","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}","href":"/api-reference/knowledge/get-a-knowledge-document"},{"title":"Update a knowledge document","description":"Updates a knowledge document's content and/or metadata. Only fields provided in the\nrequest body are updated — omitted fields are left unchanged. Provide either `html`\nor `markdown`, not both.\n\n## HTML format\n\nStandard HTML (paragraphs, headings, lists, check lists, tables, quotes, code blocks,\nimages, links, bold/italic/underline/strike) is converted to the editor's built-in\nblocks. Aptly's custom blocks and inline items are written as elements carrying a\ntype attribute plus one `data-*` attribute per property. Property names are the\ncamelCase names below written in kebab-case (`cardId` → `data-card-id`). Omitted\nproperties take their default (empty string unless noted). Text inside a block\nelement is ignored, except for the `ai` block. `GET /api/knowledge/{id}` returns\nthese elements in the same format, so its `html` can be edited and sent back.\n\n**Blocks** — `\u003cdiv data-content-type=\"TYPE\" ...>\u003c/div>`, placed between paragraphs:\n\n| Type | Properties | Example |\n| --- | --- | --- |\n| `card` | `cardId` | `\u003cdiv data-content-type=\"card\" data-card-id=\"CARD_ID\">\u003c/div>` |\n| `task` | `taskId` | `\u003cdiv data-content-type=\"task\" data-task-id=\"TASK_ID\">\u003c/div>` |\n| `contact` | `contactId` | `\u003cdiv data-content-type=\"contact\" data-contact-id=\"CONTACT_ID\">\u003c/div>` |\n| `pageLink` | `documentId` (another knowledge document) | `\u003cdiv data-content-type=\"pageLink\" data-document-id=\"DOC_ID\">\u003c/div>` |\n| `aptlyObject` | `objectId`, `objectType`, `aptletUuid` | `\u003cdiv data-content-type=\"aptlyObject\" data-object-id=\"ID\" data-object-type=\"card\" data-aptlet-uuid=\"BOARD_UUID\">\u003c/div>` |\n| `embed` | `url`, `width` (number, default 500), `height` (number, default 400) | `\u003cdiv data-content-type=\"embed\" data-url=\"https://example.com\" data-width=\"600\" data-height=\"400\">\u003c/div>` |\n| `mermaid` | `code` (Mermaid diagram source) | `\u003cdiv data-content-type=\"mermaid\" data-code=\"graph TD; A--\u0026gt;B\">\u003c/div>` |\n| `formField` | `boardUuid`, `fieldUuid`, `fieldType`, `label`, `required` (boolean, default false), `cardId`, `boardName`, `boardIcon`, `boardColor` | `\u003cdiv data-content-type=\"formField\" data-board-uuid=\"BOARD_UUID\" data-field-uuid=\"FIELD_UUID\" data-label=\"Move-in date\" data-required=\"true\">\u003c/div>` |\n| `mergeFieldBlock` | `key`, `boardUuid`, `fieldUuid`, `cardId`, `label`, `boardName` | `\u003cdiv data-content-type=\"mergeFieldBlock\" data-key=\"KEY\" data-label=\"Unit\">\u003c/div>` |\n| `ai` | `prompt`; the element's text is the generated content | `\u003cdiv data-content-type=\"ai\" data-prompt=\"Summarize the lease\">\u003cp>Generated text\u003c/p>\u003c/div>` |\n\n**Inline items** — `\u003cspan data-inline-content-type=\"TYPE\" ...>\u003c/span>`, inside a\nparagraph, heading, list item or table cell:\n\n| Type | Properties | Example |\n| --- | --- | --- |\n| `userMention` | `id`, `entityId`, `fullName` (default `Unknown`), `type` (default `user`), `mentionedBy` | `\u003cspan data-inline-content-type=\"userMention\" data-id=\"USER_ID\" data-full-name=\"Jane Doe\">\u003c/span>` |\n| `cardMention` | `cardId` | `\u003cspan data-inline-content-type=\"cardMention\" data-card-id=\"CARD_ID\">\u003c/span>` |\n| `taskMention` | `taskId` | `\u003cspan data-inline-content-type=\"taskMention\" data-task-id=\"TASK_ID\">\u003c/span>` |\n| `mergeField` | `key`, `boardUuid`, `fieldUuid`, `cardId`, `label`, `boardName`, `fallback` (omit for no fallback) | `\u003cspan data-inline-content-type=\"mergeField\" data-key=\"KEY\" data-label=\"Rent\">\u003c/span>` |\n\nNotes:\n- Escape attribute values as HTML (`\u0026quot;`, `\u0026amp;`, `\u0026lt;`, `\u0026gt;`).\n- `true`/`false` and numbers in attributes are read as booleans and numbers.\n- An element without its `data-content-type` / `data-inline-content-type`\n attribute is treated as plain HTML, not as the custom item.\n- The `ai` block keeps only the text of its first `\u003cp>`.\n- Multi-column layouts are not supported.\n- Markdown cannot express custom blocks; use `html` for them.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/knowledge/{id}","href":"/api-reference/knowledge/update-a-knowledge-document"}]},{"group":"Email","pages":[{"title":"Create an email draft","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/email/create-draft","href":"/api-reference/email/create-an-email-draft"},{"title":"Send an email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/email/send","href":"/api-reference/email/send-an-email"}]},{"group":"App","pages":[{"title":"Verify a delegate token (keyless)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/verify","href":"/api-reference/app/verify-a-delegate-token-keyless"},{"title":"Get credential info","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/me","href":"/api-reference/app/get-credential-info"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/templates","href":"/api-reference/templates/list-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/templates","href":"/api-reference/templates/create-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/templates/{id}","href":"/api-reference/templates/get-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/templates/{id}","href":"/api-reference/templates/update-a-template"}]},{"group":"Tasks","pages":[{"title":"Search tasks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tasks/search","href":"/api-reference/tasks/search-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tasks","href":"/api-reference/tasks/create-a-task"},{"title":"Update many tasks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tasks/bulk-update","href":"/api-reference/tasks/update-many-tasks"},{"title":"Get a task by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tasks/{taskId}","href":"/api-reference/tasks/get-a-task-by-id"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/tasks/{taskId}","href":"/api-reference/tasks/update-a-task"}]},{"group":"RoutingGroups","pages":[{"title":"List routing groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/routing-groups","href":"/api-reference/routinggroups/list-routing-groups"},{"title":"Create a routing group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/routing-groups/create","href":"/api-reference/routinggroups/create-a-routing-group"},{"title":"Update a routing group","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/routing-groups/{id}","href":"/api-reference/routinggroups/update-a-routing-group"},{"title":"Archive a routing group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/routing-groups/{id}/archive","href":"/api-reference/routinggroups/archive-a-routing-group"}]},{"group":"Files","pages":[{"title":"Get a presigned URL for a direct file upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/files/upload-url","href":"/api-reference/files/get-a-presigned-url-for-a-direct-file-upload"},{"title":"Finalize a direct file upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/files/upload-complete","href":"/api-reference/files/finalize-a-direct-file-upload"}]},{"group":"WebForms","pages":[{"title":"Submit a web form","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/web-forms/{formId}","href":"/api-reference/webforms/submit-a-web-form"}]},{"group":"Tours","pages":[{"title":"List tour feedback","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tours/feedback","href":"/api-reference/tours/list-tour-feedback"},{"title":"Get one showing's tour feedback","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tours/{showingId}/feedback","href":"/api-reference/tours/get-one-showings-tour-feedback"}]},{"group":"Docs","pages":[{"title":"Fetch this OpenAPI spec","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/docs/openapi","href":"/api-reference/docs/fetch-this-openapi-spec"}]}]}]},{"tab":"Aptly Portal","icon":"door-closed","pages":[{"title":"Aptly Portal","href":"/portal/introduction"}]}]},"basePath":"","title":"Get a knowledge document - Aptly API","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}