{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Pharen","description":"Documentation for Pharen Hub — the AI workspace that unifies docs, lists, channels, mail, and agents so your team can automate workflows and move faster.","colors":{"primary":"#18181B","light":"#18181B","dark":"#E4E4E7"},"logo":{"light":"https://media.brand.dev/70fa3769-6705-48e9-8340-cef95a902e88.svg","dark":"https://media.brand.dev/de991512-f9de-434e-866d-6c978fec7b16.svg","href":"/hub/overview"},"favicon":"https://mintcdn.com/pharen/PKzZr2ECPjV_fC4g/favicon.ico?fit=max\u0026auto=format\u0026n=PKzZr2ECPjV_fC4g\u0026q=85\u0026s=760d9aee368f829557b6f7c22f1ef9e3","api":{"openapi":"openapi.json","playground":{"display":"interactive","proxy":false},"examples":{"defaults":"required","languages":["curl","javascript","python"],"prefill":true},"url":"full"},"navbar":{"links":[],"primary":{"type":"button","label":"Open Hub","href":"https://pharen.app"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/pharen"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","assistant","mcp","add-mcp"],"display":"header"},"navigation":{"languages":[{"language":"en","default":true,"href":"ui/overview"},{"language":"de","footer":{"socials":{"linkedin":"https://linkedin.com/company/pharen"}},"navbar":{"primary":{"type":"button","label":"Zum Hub","href":"https://pharen.app"}},"href":"de/ui/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pharen","hasAudioNarration":false,"actualSubdomain":"pharen","customDomains":["docs.pharen.app"],"gitSource":{"type":"github","owner":"pharenit","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae95a477c27206474ca7fe9:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"en","tag":"Pharen UI","count":109},{"language":"de","tag":"Pharen UI","count":109},{"language":"en","tag":"Pharen Hub","count":42},{"language":"de","tag":"Pharen Hub","count":36},{"language":"en","tag":"Forms and input","count":32},{"language":"de","tag":"Formulare und Eingaben","count":32},{"language":"en","tag":"Data display","count":23},{"language":"de","tag":"Datenanzeige","count":23},{"language":"en","tag":"AI Components","count":14},{"language":"de","tag":"AI Components","count":14},{"language":"en","tag":"Overlays and feedback","count":13},{"language":"de","tag":"Overlays und Feedback","count":13},{"language":"en","tag":"Actions and navigation","count":12},{"language":"de","tag":"Aktionen und Navigation","count":12},{"language":"en","tag":"API Reference","count":11},{"language":"de","tag":"API Referenz","count":11},{"language":"en","tag":"Documentation","count":10},{"language":"de","tag":"Dokumentation","count":10},{"language":"de","tag":"Start","count":8},{"language":"en","tag":"Hub","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"info@pharen.de","showHelpButton":true}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--default-border-color: var(--gray-200);--pharen-primary: #18181b;--pharen-primary-hover: #27272a;--pharen-toggle-active: #18181b;--pharen-toggle-active-foreground: #ffffff;--pharen-toggle-surface: rgb(24 24 27 / 0.05)}html,body{font-family:Inter, -apple-system, BlinkMacSystemFont, \"Segoe UI\", system-ui, sans-serif;letter-spacing:0}.mint-font-serif,.font-serif{font-family:inherit!important}.dark{--default-border-color: var(--gray-800);--pharen-toggle-active: #f4f4f5;--pharen-toggle-active-foreground: #18181b;--pharen-toggle-surface: rgb(255 255 255 / 0.08)}@media (min-width: 1024px){body{overflow-x:clip!important;overflow-y:visible!important}:has(>#navbar){overflow:visible!important}#navbar{position:sticky!important;top:0!important;z-index:50!important}#navbar :has(>#localization-select-trigger){display:contents!important}#localization-select-trigger{position:absolute!important;right:9.75rem!important;top:50%!important;transform:translateY(-50%);display:inline-flex!important;align-items:center;gap:0!important;height:2rem!important;padding:0.1875rem!important;border:1px solid var(--default-border-color);border-radius:0.625rem!important;background:var(--pharen-toggle-surface)!important}#localization-select-trigger>span,#localization-select-trigger>svg{display:none!important}#localization-select-trigger::before,#localization-select-trigger::after{display:inline-grid;place-items:center;min-width:2rem;height:1.5rem;padding-inline:0.375rem;border-radius:0.4375rem;color:var(--gray-500);font-size:0.6875rem;font-weight:650;line-height:1;letter-spacing:0.04em}#localization-select-trigger::before{content:\"EN\"}#localization-select-trigger::after{content:\"DE\"}html[lang=\"en\"] #localization-select-trigger::before,html[lang=\"de\"] #localization-select-trigger::after{color:var(--pharen-toggle-active-foreground);background:var(--pharen-toggle-active);box-shadow:0 1px 2px rgb(0 0 0 / 0.12)}}#navbar>div:last-child{padding-bottom:0.125rem}#navbar .nav-tabs-item>div.absolute{bottom:-0.125rem!important}#topbar-cta-button>a{color:#ffffff!important}#topbar-cta-button>a>span.absolute{background:var(--pharen-primary)!important;border:1px solid rgb(255 255 255 / 0.14)!important;border-radius:0.75rem!important;opacity:1!important;box-shadow:0 8px 22px rgb(24 24 27 / 0.18)!important}#topbar-cta-button>a:hover>span.absolute{background:var(--pharen-primary-hover)!important;border-color:rgb(255 255 255 / 0.2)!important}#topbar-cta-button>a span.z-10,#topbar-cta-button>a svg{color:#ffffff!important}.dark #topbar-cta-button>a{color:#ffffff!important}.dark #topbar-cta-button>a>span.absolute{background:var(--pharen-primary)!important;border-color:rgb(255 255 255 / 0.16)!important}.dark #topbar-cta-button>a:hover>span.absolute{background:var(--pharen-primary-hover)!important;border-color:rgb(255 255 255 / 0.24)!important}.dark #topbar-cta-button>a span.z-10,.dark #topbar-cta-button>a svg{color:rgb(249 250 251)!important}"},{"filePath":"preview/src/preview.css","content":"@import '@pharen/ui/styles.css';:root{--primary: #18181b;--primary-darker: #09090b;--primary-foreground: #fafafa;--ring: #a1a1aa;--sidebar-primary: var(--primary);--sidebar-primary-foreground: var(--primary-foreground)}.dark{--primary: #fafafa;--primary-darker: #e4e4e7;--primary-foreground: #18181b;--ring: #71717a;--sidebar-primary: var(--primary);--sidebar-primary-foreground: var(--primary-foreground)}*{box-sizing:border-box}html,body{margin:0;min-width:0;background:var(--background)}body{overflow:hidden}.pharen-ui-preview-root{display:flex;min-height:14rem;min-width:0;width:100%;align-items:center;justify-content:center;overflow:hidden;padding:clamp(1rem, 4vw, 2rem);background:var(--background);color:var(--foreground);isolation:isolate}.pharen-ui-preview-root>*{min-width:0;max-width:100%}.pharen-ui-preview-root:is([data-example=\"ai-model-select\"],[data-example=\"autocomplete\"],[data-example=\"combobox\"],[data-example=\"color-picker\"],[data-example=\"date-picker\"],[data-example=\"dropfile\"],[data-example=\"field\"],[data-example=\"file-upload\"],[data-example=\"form\"],[data-example=\"input-group\"],[data-example=\"input\"],[data-example=\"multi-select\"],[data-example=\"native-select\"],[data-example=\"number-field\"],[data-example=\"phone-input\"],[data-example=\"radio-group\"],[data-example=\"remote-select\"],[data-example=\"search-input\"],[data-example=\"select\"],[data-example=\"slider\"],[data-example=\"textarea\"]){min-height:12rem}.pharen-ui-preview-root:is([data-example=\"ai-model-select\"],[data-example=\"autocomplete\"],[data-example=\"combobox\"],[data-example=\"color-picker\"],[data-example=\"date-picker\"],[data-example=\"dropfile\"],[data-example=\"field\"],[data-example=\"file-upload\"],[data-example=\"form\"],[data-example=\"input-group\"],[data-example=\"input\"],[data-example=\"multi-select\"],[data-example=\"native-select\"],[data-example=\"number-field\"],[data-example=\"phone-input\"],[data-example=\"radio-group\"],[data-example=\"remote-select\"],[data-example=\"search-input\"],[data-example=\"select\"],[data-example=\"slider\"],[data-example=\"textarea\"])>*{width:100%;max-width:28rem}.pharen-ui-preview-root[data-example=\"ai-model-select\"]{min-height:10rem}.pharen-ui-preview-root[data-example=\"ai-model-select\"]>*{max-width:22rem}.pharen-ui-preview-root:is([data-example=\"accordion\"],[data-example=\"ai-plan\"],[data-example=\"alert\"],[data-example=\"aspect-ratio\"],[data-example=\"border-beam\"],[data-example=\"card\"],[data-example=\"chain-of-thought\"],[data-example=\"chart\"],[data-example=\"carousel\"],[data-example=\"checkpoint\"],[data-example=\"code-block\"],[data-example=\"collapsible\"],[data-example=\"command\"],[data-example=\"conversation\"],[data-example=\"empty-state\"],[data-example=\"empty\"],[data-example=\"filters\"],[data-example=\"frame\"],[data-example=\"item\"],[data-example=\"kanban\"],[data-example=\"message\"],[data-example=\"plan\"],[data-example=\"progress\"],[data-example=\"reasoning\"],[data-example=\"resizable\"],[data-example=\"scroll-area\"],[data-example=\"sortable\"],[data-example=\"stat-card\"],[data-example=\"table\"],[data-example=\"tabs\"],[data-example=\"timeline\"],[data-example=\"tool\"],[data-example=\"tree\"]){min-height:18rem}.pharen-ui-preview-root:is([data-example=\"accordion\"],[data-example=\"ai-plan\"],[data-example=\"alert\"],[data-example=\"aspect-ratio\"],[data-example=\"border-beam\"],[data-example=\"card\"],[data-example=\"chain-of-thought\"],[data-example=\"chart\"],[data-example=\"carousel\"],[data-example=\"checkpoint\"],[data-example=\"code-block\"],[data-example=\"collapsible\"],[data-example=\"command\"],[data-example=\"conversation\"],[data-example=\"empty-state\"],[data-example=\"empty\"],[data-example=\"filters\"],[data-example=\"frame\"],[data-example=\"item\"],[data-example=\"kanban\"],[data-example=\"message\"],[data-example=\"plan\"],[data-example=\"progress\"],[data-example=\"reasoning\"],[data-example=\"resizable\"],[data-example=\"scroll-area\"],[data-example=\"sortable\"],[data-example=\"stat-card\"],[data-example=\"table\"],[data-example=\"tabs\"],[data-example=\"timeline\"],[data-example=\"tool\"],[data-example=\"tree\"])>*{width:100%;max-width:42rem}.pharen-ui-preview-root:is([data-example=\"data-grid\"],[data-example=\"event-calendar\"],[data-example=\"gantt\"]){align-items:flex-start;justify-content:flex-start;overflow:auto;padding:1rem}.pharen-ui-preview-root:is([data-example=\"data-grid\"],[data-example=\"event-calendar\"],[data-example=\"gantt\"])>*{width:100%}.pharen-ui-preview-root[data-example=\"event-calendar\"]{min-height:44rem}.pharen-ui-preview-root[data-example=\"gantt\"]{min-height:22rem}.pharen-ui-preview-root[data-example=\"sidebar\"]{min-height:24rem;align-items:stretch;padding:1rem}.pharen-ui-preview-root[data-example=\"sidebar\"]>*{width:100%}html[data-pharen-preview-modal-open],html[data-pharen-preview-modal-open] body,html[data-pharen-preview-modal-open] .pharen-ui-preview-root{background:transparent}"}],"page":{"pagePath":"api-reference/docs/list-documents","slug":"/api-reference/docs/list-documents","pageMetadata":{"title":"List documents","sidebarTitle":"List documents","openapi":"openapi.json GET /api/kb/documents/","description":"Fetch document and collection metadata available to the API key. Requires the `docs:read` scope.","href":"/api-reference/docs/list-documents"},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Fetch document and collection metadata available to the API key. Requires the \", _jsx(_components.code, {\n children: \"docs:read\"\n }), \" scope.\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Heading,Note,ParamField,ResponseField}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Returns Pharen Docs documents visible to the key creator. Use this endpoint for document inventories, search indexing jobs, and export tools.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Required API key scope: `,_jsx(_components.code,{children:`docs:read`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters`,children:`Query parameters`}),`\n`,_jsx(ParamField,{query:`team_id`,type:`string`,id:`param-team-id`,children:_jsx(_components.p,{children:`Team UUID for team-scoped keys.`})}),`\n`,_jsx(ParamField,{query:`collection_id`,type:`string`,id:`param-collection-id`,children:_jsx(_components.p,{children:`Optional collection UUID to limit results to one collection.`})}),`\n`,_jsx(ParamField,{query:`search`,type:`string`,id:`param-search`,children:_jsx(_components.p,{children:`Search term for document names and visible metadata.`})}),`\n`,_jsx(ParamField,{query:`page`,type:`integer`,id:`param-page`,children:_jsx(_components.p,{children:`Page number for paginated responses.`})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`count`,type:`integer`,id:`param-count`,children:_jsx(_components.p,{children:`Total number of matching documents.`})}),`\n`,_jsx(ResponseField,{name:`results`,type:`array`,id:`param-results`,children:_jsx(_components.p,{children:`Document records visible to the key.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List documents","sidebarTitle":"List documents","openapi":"openapi.json GET /api/kb/documents/","description":"Fetch document and collection metadata available to the API key. Requires the `docs:read` scope.","href":"/api-reference/docs/list-documents"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Query parameters","slug":"query-parameters","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Docs"],"summary":"List documents","description":"Fetch document and collection metadata available to the API key. Requires the `docs:read` scope.","operationId":"listDocuments","parameters":["f03141aa-ec0c-41c1-a26a-f9efb3f16998","e5b33329-6f09-4300-b502-2c869d2aca83","0a66f2a1-51ad-47e3-9abd-2e31a6720a4c","69b8980d-2da6-4888-a477-16684f817cd8"],"responses":{"200":"73fddf52-aa4a-4e5b-a68a-004e2af5e1ff","401":"05facc5f-b831-4be0-99d9-e5f32e74df3d","403":"4714bc92-2d7d-4349-8f80-2a20e9ef5486"},"x-mint":{"href":"/api-reference/docs/list-documents","metadata":{"title":"List documents","sidebarTitle":"List documents","description":"Read Pharen Docs documents, collections, versions, files, and access metadata."}},"method":"get","type":"path","servers":["1f895de4-64e6-46f0-8231-4ae8e5c78431"],"security":["4e6eadef-e5dc-47b6-8762-f1d2508ecb5e"],"path":"/api/kb/documents/","baseUrlOptions":["{baseUrl}"],"title":"List documents","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"disableProxy":true,"urlDisplay":"full"},"dependencies":{"parameters":{"f03141aa-ec0c-41c1-a26a-f9efb3f16998":{"name":"collection_id","in":"query","description":"Optional collection UUID to filter documents.","schema":{"type":"string","format":"uuid","description":"Optional collection UUID to filter documents.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"e5b33329-6f09-4300-b502-2c869d2aca83":{"name":"team_id","in":"query","description":"Team UUID for team-scoped keys.","schema":{"type":"string","format":"uuid","description":"Team UUID for team-scoped keys.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"0a66f2a1-51ad-47e3-9abd-2e31a6720a4c":{"name":"page","in":"query","description":"Page number for paginated results.","schema":{"type":"integer","minimum":1,"default":1,"description":"Page number for paginated results.","uniqueKey":"","typeLabel":"integer"}},"69b8980d-2da6-4888-a477-16684f817cd8":{"name":"per_page","in":"query","description":"Number of results per page.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Number of results per page.","uniqueKey":"","typeLabel":"integer"}}},"responses":{"73fddf52-aa4a-4e5b-a68a-004e2af5e1ff":{"description":"Documents returned.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","uniqueKey":"data.items.[INDEX].title","typeLabel":"string"},"collection_id":{"type":"string","format":"uuid","uniqueKey":"data.items.[INDEX].collection_id","typeLabel":"string\u003cuuid>"},"team_id":{"type":"string","format":"uuid","uniqueKey":"data.items.[INDEX].team_id","typeLabel":"string\u003cuuid>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data","typeLabel":"object[]"},"total":{"type":"integer","uniqueKey":"total","typeLabel":"integer"},"page":{"type":"integer","uniqueKey":"page","typeLabel":"integer"},"per_page":{"type":"integer","uniqueKey":"per_page","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","title":"\u003cstring>","collection_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","team_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","updated_at":"2023-11-07T05:31:56Z"}],"total":123,"page":123,"per_page":123}}},"exampleType":"generated"}},"exampleType":"generated"},"05facc5f-b831-4be0-99d9-e5f32e74df3d":{"description":"The request did not include a valid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"forbidden","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"This API key does not have the required scope.","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"This API key does not have the required scope.","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"4714bc92-2d7d-4349-8f80-2a20e9ef5486":{"description":"The API key is valid but does not have the required scope or workspace access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"forbidden","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"This API key does not have the required scope.","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"This API key does not have the required scope.","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4e6eadef-e5dc-47b6-8762-f1d2508ecb5e":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Paste your Pharen API key without the Bearer prefix.","x-default":"phk_your_api_key","scopes":[]}}},"servers":{"1f895de4-64e6-46f0-8231-4ae8e5c78431":{"description":"API base URL","url":"{baseUrl}","variables":{"baseUrl":{"default":"https://pharen.app","description":"Full API origin, including http:// or https://. Use https://pharen.app for production or http://localhost:8000 for local development."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Paste your Pharen API key without the Bearer prefix.","x-default":"phk_your_api_key","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Paste your Pharen API key without the Bearer prefix.","format":"bearer","default":"phk_your_api_key","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"pharen","siteName":"Pharen","title":"List documents - Pharen","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/docs/list-documents","matchLevel":0},"de":{"href":"/de/api-reference/docs/list-documents","matchLevel":1}}},"lastModified":"2026-06-28T09:53:58.384Z","originalFileLocation":"api-reference/docs/list-documents.mdx","locale":"en"},"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=\"Fetch document and collection metadata available to the API key. Requires the docs:read scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pharen\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pharen/8YbPujggZP556MaY/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/pharen/8YbPujggZP556MaY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pharen/8YbPujggZP556MaY/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pharen/8YbPujggZP556MaY/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pharen/8YbPujggZP556MaY/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pharen/8YbPujggZP556MaY/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pharen/8YbPujggZP556MaY/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pharen/8YbPujggZP556MaY/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pharen/8YbPujggZP556MaY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List documents - Pharen\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch document and collection metadata available to the API key. Requires the docs:read scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pharen\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pharen.app/api-reference/docs/list-documents\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pharen.mintlify.site/_mintlify/api/og/v2?division=Docs\u0026amp;title=List+documents\u0026amp;description=Fetch+document+and+collection+metadata+available+to+the+API+key.+Requires+the+%60docs%3Aread%60+scope.\u0026amp;theme=9be6127414cfc615a15bf921\u0026amp;signature=16ea02fcdc419af1ebeeffafbb41d63ba020247bcafbc3405dd37031757c8cfe\">\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=\"List documents - Pharen\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch document and collection metadata available to the API key. Requires the docs:read scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pharen.mintlify.site/_mintlify/api/og/v2?division=Docs\u0026amp;title=List+documents\u0026amp;description=Fetch+document+and+collection+metadata+available+to+the+API+key.+Requires+the+%60docs%3Aread%60+scope.\u0026amp;theme=9be6127414cfc615a15bf921\u0026amp;signature=16ea02fcdc419af1ebeeffafbb41d63ba020247bcafbc3405dd37031757c8cfe\">\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=\"/mintlify-assets/_mintlify/favicons/pharen/8YbPujggZP556MaY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pharen\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#18181B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pharen.app/api-reference/docs/list-documents\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/docs/list-documents.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.pharen.app/api-reference/docs/list-documents\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.pharen.app/de/api-reference/docs/list-documents\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.pharen.app/api-reference/docs/list-documents\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pharen.app/#organization\",\"name\":\"Pharen\",\"url\":\"https://docs.pharen.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://media.brand.dev/70fa3769-6705-48e9-8340-cef95a902e88.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pharen.app#website\",\"name\":\"Pharen\",\"url\":\"https://docs.pharen.app\",\"publisher\":{\"@id\":\"https://docs.pharen.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pharen.app/api-reference/docs/list-documents#webpage\",\"url\":\"https://docs.pharen.app/api-reference/docs/list-documents\",\"name\":\"List documents\",\"description\":\"Fetch document and collection metadata available to the API key. Requires the docs:read scope.\",\"dateModified\":\"2026-06-28T09:53:58.384Z\",\"isPartOf\":{\"@id\":\"https://docs.pharen.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pharen.app/api-reference/docs/list-documents#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pharen.app/api-reference/docs/list-documents#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pharen\",\"item\":\"https://docs.pharen.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List documents\",\"item\":\"https://docs.pharen.app/api-reference/docs/list-documents\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pharen.app/api-reference/docs/list-documents#apireference\",\"headline\":\"List documents\",\"name\":\"List documents\",\"description\":\"Fetch document and collection metadata available to the API key. Requires the docs:read scope.\",\"url\":\"https://docs.pharen.app/api-reference/docs/list-documents\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pharen.app/api-reference/docs/list-documents#webpage\"},\"dateModified\":\"2026-06-28T09:53:58.384Z\",\"publisher\":{\"@id\":\"https://docs.pharen.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pharen.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pharen\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Pharen\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/docs/list-documents.md","siteName":"Pharen","nav":{"global":null,"languages":[{"language":"en","default":true,"products":[{"product":"Pharen UI","icon":"blocks","description":"Vue 3 components, design tokens, and AI interface patterns.","pages":[{"title":"Pharen UI","href":"/ui/overview"}]},{"product":"Pharen Hub","icon":"panels-top-left","description":"AI workspace, workflow automation, administration, and API.","tabs":[{"tab":"Hub","pages":[{"title":"Hub","href":"/hub/overview"}]},{"tab":"General","pages":[{"title":"General","href":"/general/overview"}]},{"tab":"Mobile","pages":[{"title":"Mobile","href":"/mobile/overview"}]},{"tab":"Workflows","pages":[{"title":"Workflows","href":"/workflows/overview"}]},{"tab":"Lists","pages":[{"title":"Lists","href":"/lists/overview"}]},{"tab":"Studio","pages":[{"title":"Studio","href":"/studio/overview"}]},{"tab":"Transformation","pages":[{"title":"Transformation","href":"/transformation/overview"}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","icon":"book-open","expanded":true,"pages":[{"title":"Pharen Hub REST API reference: base URL and authentication","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"Pharen API Authentication: API Keys and Bearer Tokens","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"title":"Manage Pharen Hub API keys: create, scope, and rotate","sidebarTitle":"API Keys","href":"/api-reference/api-keys"}]},{"group":"Calendar","icon":"calendar","pages":[{"title":"List calendar events","sidebarTitle":"List events","openapi":"openapi.json GET /api/calendar/events/","href":"/api-reference/calendar/list-events"},{"title":"Create calendar event","sidebarTitle":"Create event","openapi":"openapi.json POST /api/calendar/events/","href":"/api-reference/calendar/create-event"}]},{"group":"Lists","icon":"list","pages":[{"title":"List saved lists","sidebarTitle":"List lists","openapi":"openapi.json GET /api/lists/","description":"Fetch list metadata and saved list data available to the API key. Requires the `lists:read` scope.","href":"/api-reference/lists/list-lists"}]},{"group":"Docs","icon":"file-text","pages":[{"title":"List documents","sidebarTitle":"List documents","openapi":"openapi.json GET /api/kb/documents/","href":"/api-reference/docs/list-documents"}]},{"group":"Workflows","icon":"workflow","pages":[{"title":"List workflows","sidebarTitle":"List workflows","openapi":"openapi.json GET /api/flow/workflows/","description":"Fetch workflow definitions available to the API key. Requires the `workflows:read` scope.","href":"/api-reference/workflows/list-workflows"},{"title":"Run workflow","sidebarTitle":"Run workflow","openapi":"openapi.json POST /api/flow/workflows/{workflow_uuid}/execute/","href":"/api-reference/workflows/run-workflow"}]},{"group":"Agents","icon":"bot","pages":[{"title":"List agents","sidebarTitle":"List agents","openapi":"openapi.json GET /api/agents/","href":"/api-reference/agents/list-agents"},{"title":"Chat with agent","sidebarTitle":"Chat with agent","openapi":"openapi.json POST /api/agents/{agent_uuid}/chat/","href":"/api-reference/agents/chat-agent"}]}]}]}]},{"language":"de","footer":{"socials":{"linkedin":"https://linkedin.com/company/pharen"}},"navbar":{"primary":{"type":"button","label":"Zum Hub","href":"https://pharen.app"}},"pages":[{"title":"de","href":"/de/api-reference/docs/list-documents"}]}]},"basePath":"","title":"List documents - Pharen","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}