{
"code": "UNAUTHORIZED",
"status": 401,
"title": "Unauthorized",
"message": "You are not authorized to access this resource",
"meta": {
"log_id": "65c669d4-679c-4a8b-b8c0-fbe37699bb5b"
}
}
Documents
Get Document
Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.
GET
/
v1
/
documents
List documents
curl --request GET \
--url https://api.wellapp.ai/v1/documents \
--header 'Authorization: <authorization>'
This example demonstrates advanced filtering with multiple parameters, relationship inclusion, file type filtering, and sorting for retrieving documents:
Filter and sort on a related (included) object by nesting into the relationship — the same relationships you pass to include.
To-one relations nest directly: { "issuer": { "name": { "_eq": "Acme" } } }, and sort by a dot-path: "orderBy": { "field": "issuer.name", "direction": "asc" }.
To-many relations must be quantified with _some, _every, or _none: { "items": { "_some": { "quantity": { "_gt": 1 } } } }. They are not directly sortable (a to-many sort needs an aggregate proxy).
Compositecomposite_* columns are virtual — filter and sort on their underlying source fields, not on the composite.
Workspace row-level security applies at every hop, so a related-object filter never widens your tenant scope. Full operator set, deep-nesting rules, and pagination notes: Filtering & sorting.This resource’s related objects (the ones you can include) and how to filter or sort on each:
Replace field_name with any field of the related object. See its object-reference page for the full field list.Filter by a to-one relation (and sort by it):
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Well Starter Kit","colors":{"primary":"#3B82F6","light":"#3B82F6","dark":"#3B82F6"},"logo":{"light":"https://mintcdn.com/well/j74jFqWG-NeLKp8o/logo/light.svg?fit=max\u0026auto=format\u0026n=j74jFqWG-NeLKp8o\u0026q=85\u0026s=ec61453b9226be3e275aa07423c1e891","dark":"https://mintcdn.com/well/j74jFqWG-NeLKp8o/logo/dark.svg?fit=max\u0026auto=format\u0026n=j74jFqWG-NeLKp8o\u0026q=85\u0026s=8b28f381de23d37773a8d1859b2dfaf9"},"favicon":"https://mintcdn.com/well/j74jFqWG-NeLKp8o/favicon.svg?fit=max\u0026auto=format\u0026n=j74jFqWG-NeLKp8o\u0026q=85\u0026s=22aaf8a14c21de66873177773d1e4612","navbar":{"primary":{"type":"button","label":"Subscribe","href":"https://wellapp.ai/"}},"footer":{"socials":{"x":"https://x.com/getwellapp","github":"https://github.com/WellApp-ai/Well","linkedin":"https://www.linkedin.com/company/wellappai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"well","hasAudioNarration":false,"actualSubdomain":"well","customDomains":["docs.wellapp.ai"],"gitSource":{"type":"github","owner":"wellapp-ai","repo":"platform","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a27f16ba576bda77fb66740","collectionId":"42433f39-640d-45e6-b1ef-d815a93c5947","schemaVersion":"v3"},"feedback":{"thumbs":false},"entitlements":{},"buildId":"6a98bf0e9c7213568723e5f2:failure","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":115},{"language":"default","tag":"Data Model","count":87},{"language":"default","tag":"Enums","count":50},{"language":"default","tag":"Records — read endpoints","count":44},{"language":"default","tag":"Atomic Resources","count":27},{"language":"default","tag":"Infrastructure objects","count":27},{"language":"default","tag":"Main Resources","count":26},{"language":"default","tag":"Supporting objects","count":26},{"language":"default","tag":"System","count":18},{"language":"default","tag":"Platform objects","count":14}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/documents/get-all","slug":"/api-reference/endpoint/documents/get-all","pageMetadata":{"title":"Get Document","openapi":"GET /v1/documents","description":"Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.","href":"/api-reference/endpoint/documents/get-all"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.\"\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={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`complex-usage-example`,children:`Complex Usage Example`}),`\n`,_jsx(Heading,{level:`3`,id:`advanced-document-filtering-with-full-context`,children:`Advanced Document Filtering with Full Context`}),`\n`,_jsx(_components.p,{children:`This example demonstrates advanced filtering with multiple parameters, relationship inclusion, file type filtering, and sorting for retrieving documents:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.well.com/v1/documents?include=media,invoice\u0026filter[workspace_id]=550e8400-e29b-41d4-a716-446655440000\u0026filter[status]=completed\u0026filter[file_type]=pdf\u0026filter[uploaded_at][from]=2024-01-01T00:00:00Z\u0026filter[uploaded_at][to]=2024-12-31T23:59:59Z\u0026filter[processed_at][from]=2024-06-01T00:00:00Z\u0026sort=-uploaded_at\u0026limit=25\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`filtering-\u0026-sorting-on-related-objects`,children:`Filtering \u0026 sorting on related objects`}),`\n`,_jsxs(_components.p,{children:[`Filter and sort on a `,_jsx(_components.strong,{children:`related (included) object`}),` by nesting into the relationship — the same relationships you pass to `,_jsx(_components.code,{children:`include`}),`.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`To-one`}),` relations nest directly: `,_jsx(_components.code,{children:`{ \"issuer\": { \"name\": { \"_eq\": \"Acme\" } } }`}),`, and sort by a dot-path: `,_jsx(_components.code,{children:`\"orderBy\": { \"field\": \"issuer.name\", \"direction\": \"asc\" }`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`To-many`}),` relations must be quantified with `,_jsx(_components.code,{children:`_some`}),`, `,_jsx(_components.code,{children:`_every`}),`, or `,_jsx(_components.code,{children:`_none`}),`: `,_jsx(_components.code,{children:`{ \"items\": { \"_some\": { \"quantity\": { \"_gt\": 1 } } } }`}),`. They are `,_jsx(_components.strong,{children:`not`}),` directly sortable (a to-many sort needs an aggregate proxy).`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Composite`}),` `,_jsx(_components.code,{children:`composite_*`}),` columns are virtual — filter and sort on their underlying source fields, not on the composite.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Workspace row-level security applies at every hop, so a related-object filter never widens your tenant scope. Full operator set, deep-nesting rules, and pagination notes: `,_jsx(_components.a,{href:`/api-reference/filtering-and-sorting`,children:`Filtering \u0026 sorting`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`This resource’s related objects (the ones you can `,_jsx(_components.code,{children:`include`}),`) and how to filter or sort on each:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Relationship`}),_jsx(_components.th,{children:`Cardinality`}),_jsx(_components.th,{children:`Filter on a field`}),_jsx(_components.th,{children:`Sort by a field`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`workspace`})}),_jsx(_components.td,{children:`to-one (workspace)`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"workspace\": { \"name\": { \"_eq\": … } } }`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`\"field\": \"workspace.name\"`}),` ✅`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`collect`})}),_jsx(_components.td,{children:`to-one (collect)`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"collect\": { \"field_name\": { \"_eq\": … } } }`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`\"field\": \"collect.field_name\"`}),` ✅`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`source_workspace_connector`})}),_jsx(_components.td,{children:`to-one (workspace_connector)`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"source_workspace_connector\": { \"name\": { \"_eq\": … } } }`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`\"field\": \"source_workspace_connector.name\"`}),` ✅`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invoices`})}),_jsx(_components.td,{children:`to-many (invoice)`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"invoices\": { \"_some\": { \"grand_total\": { \"_eq\": … } } } }`})}),_jsx(_components.td,{children:`aggregate proxy only ⚠️`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`transaction_documents`})}),_jsx(_components.td,{children:`to-many (transaction_document)`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"transaction_documents\": { \"_some\": { \"field_name\": { \"_eq\": … } } } }`})}),_jsx(_components.td,{children:`aggregate proxy only ⚠️`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Replace `,_jsx(_components.code,{children:`field_name`}),` with any field of the related object. See its object-reference page for the full field list.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Filter by a to-one relation`}),` (and sort by it):`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"root\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"documents\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"whereClause\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"workspace\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"_ilike\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"%acme%\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } } },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"orderBy\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"workspace.name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"direction\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"asc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Filter by a to-many relation`}),` (quantified — bare nesting is invalid):`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"root\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"documents\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"whereClause\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"invoices\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"_some\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"grand_total\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"_gt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } } } }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}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":"Get Document","openapi":"GET /v1/documents","description":"Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.","href":"/api-reference/endpoint/documents/get-all"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Complex Usage Example","slug":"complex-usage-example","depth":2,"children":[{"title":"Advanced Document Filtering with Full Context","slug":"advanced-document-filtering-with-full-context","depth":3,"children":[]}]},{"title":"Filtering \u0026 sorting on related objects","slug":"filtering-\u0026-sorting-on-related-objects","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"List documents","description":"Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.","parameters":["b2e6f107-0e09-4f22-9d50-82ae191946dc","262bc7ce-748f-4dc2-ada3-75baecb84e7e","2fb00365-c70b-46a9-8379-6e601b0693d7","7f977f91-53ef-4535-ab0e-df2edaa027a4","0e5f6bfe-a45f-4039-923f-027993d066e6","2dad414c-cd7a-40ea-b72b-fce8da4a229a","edbc8443-5fbf-4267-8ea1-784ac2f01bc0","d3526436-cd1e-4094-a4c0-d2b75eac2a4c","5117df74-5c8c-4523-b21e-78623247df29","e424b17a-c6c8-4602-9ee8-d5167ad104c2","f519528a-f6f2-497d-bfa7-1b8ad3bd2231","c2b7971c-96a0-466c-a448-e6093382d8df"],"responses":{"200":"858280a3-207d-4fa1-a9c2-97b74b76309f","401":"bb3d811a-5781-4735-a0ea-0cbc04343e2e"},"method":"get","type":"path","servers":["4cb86cf8-c8c0-4af5-bb4b-4aa6ecdcbcfb"],"security":[],"path":"/v1/documents","baseUrlOptions":["https://api.wellapp.ai"],"title":"List documents","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b2e6f107-0e09-4f22-9d50-82ae191946dc":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string","isRequired":true,"description":"Bearer token for authentication","uniqueKey":"","typeLabel":"string"},"description":"Bearer token for authentication"},"262bc7ce-748f-4dc2-ada3-75baecb84e7e":{"name":"include","in":"query","required":false,"schema":{"type":"string","enum":["media","invoice"],"isRequired":false,"description":"Include detailed relationship data in the response. Comma-separated values supported.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Include detailed relationship data in the response. Comma-separated values supported.","example":"media,invoice"},"2fb00365-c70b-46a9-8379-6e601b0693d7":{"name":"filter[uploaded_at][from]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Filter documents uploaded from this date/time","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Filter documents uploaded from this date/time","example":"2024-01-01T00:00:00Z"},"7f977f91-53ef-4535-ab0e-df2edaa027a4":{"name":"filter[uploaded_at][to]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Filter documents uploaded up to this date/time","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Filter documents uploaded up to this date/time","example":"2024-12-31T23:59:59Z"},"0e5f6bfe-a45f-4039-923f-027993d066e6":{"name":"filter[processed_at][from]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Filter documents processed from this date/time","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Filter documents processed from this date/time","example":"2024-01-01T00:00:00Z"},"2dad414c-cd7a-40ea-b72b-fce8da4a229a":{"name":"filter[processed_at][to]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Filter documents processed up to this date/time","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Filter documents processed up to this date/time","example":"2024-12-31T23:59:59Z"},"edbc8443-5fbf-4267-8ea1-784ac2f01bc0":{"name":"filter[workspace_id]","in":"query","required":false,"schema":{"type":"string","format":"uuid","isRequired":false,"description":"Filter documents by workspace ID","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Filter documents by workspace ID","example":"550e8400-e29b-41d4-a716-446655440000"},"d3526436-cd1e-4094-a4c0-d2b75eac2a4c":{"name":"filter[external_workspace_id]","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Filter documents by external workspace ID","uniqueKey":"","typeLabel":"string"},"description":"Filter documents by external workspace ID","example":"ext-workspace-123"},"5117df74-5c8c-4523-b21e-78623247df29":{"name":"filter[status]","in":"query","required":false,"schema":{"type":"string","enum":["pending","processing","completed","failed","deleted"],"isRequired":false,"description":"Filter documents by processing status","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Filter documents by processing status","example":"completed"},"e424b17a-c6c8-4602-9ee8-d5167ad104c2":{"name":"filter[file_type]","in":"query","required":false,"schema":{"type":"string","enum":["pdf","image","word","excel","text"],"isRequired":false,"description":"Filter documents by file type","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Filter documents by file type","example":"pdf"},"f519528a-f6f2-497d-bfa7-1b8ad3bd2231":{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["uploaded_at","-uploaded_at","processed_at","-processed_at"],"isRequired":false,"description":"Sort documents by field. Use - prefix for descending order.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Sort documents by field. Use - prefix for descending order.","example":"-uploaded_at"},"c2b7971c-96a0-466c-a448-e6093382d8df":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"isRequired":false,"description":"Number of documents per page","uniqueKey":"","typeLabel":"integer"},"description":"Number of documents per page","example":20}},"responses":{"858280a3-207d-4fa1-a9c2-97b74b76309f":{"description":"Documents retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","enum":["document"],"uniqueKey":"data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"attributes":{"type":"object","properties":{"file_name":{"type":"string","uniqueKey":"data.items.[INDEX].attributes.file_name","typeLabel":"string"},"status":{"type":"string","uniqueKey":"data.items.[INDEX].attributes.status","typeLabel":"string"},"uploaded_at":{"type":"string","format":"date-time","uniqueKey":"data.items.[INDEX].attributes.uploaded_at","typeLabel":"string\u003cdate-time>"},"processed_at":{"type":"string","format":"date-time","uniqueKey":"data.items.[INDEX].attributes.processed_at","typeLabel":"string\u003cdate-time>"},"file_type":{"type":"string","uniqueKey":"data.items.[INDEX].attributes.file_type","typeLabel":"string"},"size_bytes":{"type":"integer","uniqueKey":"data.items.[INDEX].attributes.size_bytes","typeLabel":"integer"}},"uniqueKey":"data.items.[INDEX].attributes","typeLabel":"object"},"relationships":{"type":"object","properties":{"company":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["company"],"uniqueKey":"data.items.[INDEX].relationships.company.data.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"data.items.[INDEX].relationships.company.data.id","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].relationships.company.data","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].relationships.company","typeLabel":"object"},"people":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["people"],"uniqueKey":"data.items.[INDEX].relationships.people.data.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"data.items.[INDEX].relationships.people.data.id","typeLabel":"string"},"meta":{"type":"object","properties":{"phone_number":{"type":"string","uniqueKey":"data.items.[INDEX].relationships.people.data.meta.phone_number","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].relationships.people.data.meta","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].relationships.people.data","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].relationships.people","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].relationships","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":[{"type":"document","id":"550e8400-e29b-41d4-a716-446655440010","attributes":{"file_name":"invoice_2024.pdf","workspace_id":"550e8400-e29b-41d4-a716-446655440001","collect_id":"550e8400-e29b-41d4-a716-446655440002","metadata":{"source_number":"+33123456789","target_number":"+33987654321","document_type":"invoice"},"created_at":"2024-01-20T10:30:00Z","updated_at":"2024-01-20T10:30:00Z"},"relationships":{"workspace":{"data":{"type":"workspace","id":"550e8400-e29b-41d4-a716-446655440001"}},"company":{"data":{"type":"company","id":"550e8400-e29b-41d4-a716-446655440003"}},"people":{"data":{"type":"people","id":"550e8400-e29b-41d4-a716-446655440004","meta":{"phone_number":"+33123456789"}}}}}],"included":[{"type":"workspace","id":"550e8400-e29b-41d4-a716-446655440001","attributes":{"name":"Sales Team Workspace","description":"Workspace for sales documents and invoices","avatar_color":"#4A90E2","external_workspace_id":"sales_ws_001","auto_extract_enabled":true,"created_at":"2024-01-15T09:00:00Z","updated_at":"2024-01-15T09:00:00Z"}},{"type":"company","id":"550e8400-e29b-41d4-a716-446655440003","attributes":{"name":"ACME Corporation","description":"Leading technology and consulting company","locale":"fr","domain_name_primary_link_url":"acme.com","tax_id":{"value":"FR12345678901","type":"VAT"},"registration":{"trade_name":"ACME","registered_name":"ACME Corporation SAS"},"registration_number":{"business_type":"SAS","value":"RCS 123456789","registry_name":"Registre du Commerce Paris","registry_country":"FR"},"created_at":"2024-01-10T08:00:00Z","updated_at":"2024-01-10T08:00:00Z"}},{"type":"people","id":"550e8400-e29b-41d4-a716-446655440004","attributes":{"first_name":"Jean","last_name":"Dupont","full_name":"Jean Dupont","created_at":"2024-01-12T10:00:00Z","updated_at":"2024-01-12T10:00:00Z"}}],"meta":{"total":150,"page":1,"limit":20}},"examples":{"Example":{"title":"Example","value":{"data":[{"type":"document","id":"550e8400-e29b-41d4-a716-446655440010","attributes":{"file_name":"invoice_2024.pdf","workspace_id":"550e8400-e29b-41d4-a716-446655440001","collect_id":"550e8400-e29b-41d4-a716-446655440002","metadata":{"source_number":"+33123456789","target_number":"+33987654321","document_type":"invoice"},"created_at":"2024-01-20T10:30:00Z","updated_at":"2024-01-20T10:30:00Z"},"relationships":{"workspace":{"data":{"type":"workspace","id":"550e8400-e29b-41d4-a716-446655440001"}},"company":{"data":{"type":"company","id":"550e8400-e29b-41d4-a716-446655440003"}},"people":{"data":{"type":"people","id":"550e8400-e29b-41d4-a716-446655440004","meta":{"phone_number":"+33123456789"}}}}}],"included":[{"type":"workspace","id":"550e8400-e29b-41d4-a716-446655440001","attributes":{"name":"Sales Team Workspace","description":"Workspace for sales documents and invoices","avatar_color":"#4A90E2","external_workspace_id":"sales_ws_001","auto_extract_enabled":true,"created_at":"2024-01-15T09:00:00Z","updated_at":"2024-01-15T09:00:00Z"}},{"type":"company","id":"550e8400-e29b-41d4-a716-446655440003","attributes":{"name":"ACME Corporation","description":"Leading technology and consulting company","locale":"fr","domain_name_primary_link_url":"acme.com","tax_id":{"value":"FR12345678901","type":"VAT"},"registration":{"trade_name":"ACME","registered_name":"ACME Corporation SAS"},"registration_number":{"business_type":"SAS","value":"RCS 123456789","registry_name":"Registre du Commerce Paris","registry_country":"FR"},"created_at":"2024-01-10T08:00:00Z","updated_at":"2024-01-10T08:00:00Z"}},{"type":"people","id":"550e8400-e29b-41d4-a716-446655440004","attributes":{"first_name":"Jean","last_name":"Dupont","full_name":"Jean Dupont","created_at":"2024-01-12T10:00:00Z","updated_at":"2024-01-12T10:00:00Z"}}],"meta":{"total":150,"page":1,"limit":20}}}},"exampleType":"examples"}},"exampleType":"examples"},"bb3d811a-5781-4735-a0ea-0cbc04343e2e":{"description":"Unauthorized - invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"UNAUTHORIZED","description":"Error code identifier","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","example":401,"description":"HTTP status code","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"type":"string","example":"Unauthorized","description":"Error title","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"message":{"type":"string","example":"You are not authorized to access this resource","description":"Detailed error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"meta":{"type":"object","properties":{"log_id":{"type":"string","format":"uuid","example":"65c669d4-679c-4a8b-b8c0-fbe37699bb5b","description":"Unique identifier for tracking this error in logs","isRequired":true,"uniqueKey":"meta.log_id","typeLabel":"string\u003cuuid>"}},"required":["log_id"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["code","status","title","message","meta"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"UNAUTHORIZED","status":401,"title":"Unauthorized","message":"You are not authorized to access this resource","meta":{"log_id":"65c669d4-679c-4a8b-b8c0-fbe37699bb5b"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"4cb86cf8-c8c0-4af5-bb4b-4aa6ecdcbcfb":{"url":"https://api.wellapp.ai"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"well","siteName":"Well Starter Kit","title":"Get Document - Well Starter Kit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-09T10:57:17.187Z","originalFileLocation":"api-reference/endpoint/documents/get-all.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=\"Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Well Starter Kit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/well/8leEQflIFXlElmHq/_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/well/8leEQflIFXlElmHq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/well/8leEQflIFXlElmHq/_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/well/8leEQflIFXlElmHq/_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/well/8leEQflIFXlElmHq/_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/well/8leEQflIFXlElmHq/_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/well/8leEQflIFXlElmHq/_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/well/8leEQflIFXlElmHq/_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/well/8leEQflIFXlElmHq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Document - Well Starter Kit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Well Starter Kit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wellapp.ai/api-reference/endpoint/documents/get-all\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://well.mintlify.app/_mintlify/api/og/v2?division=Documents\u0026amp;title=Get+Document\u0026amp;description=Retrieve+a+list+of+documents+with+optional+filtering%2C+sorting%2C+and+relationship+inclusion.+By+default%2C+only+document+IDs+are+returned+for+relationships.\u0026amp;theme=ac0abee58ec9325d06e46287\u0026amp;signature=ce138d7c380b7d25d65378d40594e1272aa95764d6037194e9b79e144e7d11d5\">\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 Document - Well Starter Kit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://well.mintlify.app/_mintlify/api/og/v2?division=Documents\u0026amp;title=Get+Document\u0026amp;description=Retrieve+a+list+of+documents+with+optional+filtering%2C+sorting%2C+and+relationship+inclusion.+By+default%2C+only+document+IDs+are+returned+for+relationships.\u0026amp;theme=ac0abee58ec9325d06e46287\u0026amp;signature=ce138d7c380b7d25d65378d40594e1272aa95764d6037194e9b79e144e7d11d5\">\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/well/8leEQflIFXlElmHq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Well Starter Kit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B82F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wellapp.ai/api-reference/endpoint/documents/get-all\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/documents/get-all.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wellapp.ai/#organization\",\"name\":\"Well Starter Kit\",\"url\":\"https://docs.wellapp.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/well/j74jFqWG-NeLKp8o/logo/light.svg?fit=max\u0026auto=format\u0026n=j74jFqWG-NeLKp8o\u0026q=85\u0026s=ec61453b9226be3e275aa07423c1e891\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wellapp.ai#website\",\"name\":\"Well Starter Kit\",\"url\":\"https://docs.wellapp.ai\",\"publisher\":{\"@id\":\"https://docs.wellapp.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wellapp.ai/api-reference/endpoint/documents/get-all#webpage\",\"url\":\"https://docs.wellapp.ai/api-reference/endpoint/documents/get-all\",\"name\":\"Get Document\",\"description\":\"Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.\",\"dateModified\":\"2026-06-09T10:57:17.187Z\",\"isPartOf\":{\"@id\":\"https://docs.wellapp.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wellapp.ai/api-reference/endpoint/documents/get-all#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wellapp.ai/api-reference/endpoint/documents/get-all#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Atomic Resources\",\"item\":\"https://docs.wellapp.ai/api-reference/endpoint/emails/create-email\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documents\",\"item\":\"https://docs.wellapp.ai/api-reference/endpoint/documents/create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Document\",\"item\":\"https://docs.wellapp.ai/api-reference/endpoint/documents/get-all\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wellapp.ai/api-reference/endpoint/documents/get-all#apireference\",\"headline\":\"Get Document\",\"name\":\"Get Document\",\"description\":\"Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.\",\"url\":\"https://docs.wellapp.ai/api-reference/endpoint/documents/get-all\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wellapp.ai/api-reference/endpoint/documents/get-all#webpage\"},\"dateModified\":\"2026-06-09T10:57:17.187Z\",\"publisher\":{\"@id\":\"https://docs.wellapp.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wellapp.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Well Starter Kit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Well Starter Kit","nav":{"global":null,"tabs":[{"tab":"Get started","icon":"rocket","pages":[{"title":"Get started","href":"/api-reference/get-started"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Main Resources","pages":[{"group":"Companies","pages":[{"title":"Create Company","openapi":"POST /v1/companies","href":"/api-reference/endpoint/companies/create"},{"title":"Get Company by id","openapi":"GET /v1/companies/{id}","href":"/api-reference/endpoint/companies/get"},{"title":"Get Companies","openapi":"GET /v1/companies","href":"/api-reference/endpoint/companies/getAll"},{"title":"Update Company","openapi":"PATCH /v1/companies/{id}","href":"/api-reference/endpoint/companies/update"},{"title":"Delete Company","openapi":"DELETE /v1/companies/{id}","href":"/api-reference/endpoint/companies/delete"}]},{"group":"Connectors","pages":[{"title":"Create Connectors","openapi":"POST /v1/connectors","href":"/api-reference/endpoint/connectors/create"},{"title":"Get Connectors by id","openapi":"GET /v1/connectors/{id}","href":"/api-reference/endpoint/connectors/get"},{"title":"Get Connectors","openapi":"GET /v1/connectors","href":"/api-reference/endpoint/connectors/get-all"},{"title":"Update Connectors","openapi":"PATCH /v1/connectors/{id}","href":"/api-reference/endpoint/connectors/update"},{"title":"Delete Connectors","openapi":"DELETE /v1/connectors/{id}","href":"/api-reference/endpoint/connectors/delete"}]},{"group":"Payment Means","pages":[{"title":"Create Payment Mean","openapi":"POST /v1/payment-means","href":"/api-reference/endpoint/payment-means/create"},{"title":"Update Payment Mean","openapi":"PATCH /v1/payment-means/{id}","href":"/api-reference/endpoint/payment-means/update"},{"title":"Delete Payment Mean","openapi":"DELETE /v1/payment-means/{id}","href":"/api-reference/endpoint/payment-means/delete"}]},{"group":"People","pages":[{"title":"Create Person","openapi":"POST /v1/people","href":"/api-reference/endpoint/people/create"},{"title":"List People","openapi":"GET /v1/people","href":"/api-reference/endpoint/people/get-all"},{"title":"Get Person","openapi":"GET /v1/people/{id}","href":"/api-reference/endpoint/people/get"},{"title":"Delete Person","openapi":"DELETE /v1/people/{id}","href":"/api-reference/endpoint/people/delete"},{"title":"Link Companies to Person","openapi":"POST /v1/people/{peopleId}/relationships/companies","href":"/api-reference/endpoint/people/add-companies-to-person"}]},{"group":"Invoices","pages":[{"title":"Get Invoice","openapi":"GET /v1/invoices/{id}","href":"/api-reference/endpoint/invoices/get"},{"title":"Get Invoices","openapi":"GET /v1/invoices","href":"/api-reference/endpoint/invoices/get-all"},{"title":"Create Invoices","openapi":"POST /v1/invoices","href":"/api-reference/endpoint/invoices/post"},{"title":"Patch Invoice","openapi":"PATCH /v1/invoices/{id}","href":"/api-reference/endpoint/invoices/patch"},{"title":"Delete Invoice","openapi":"DELETE /v1/invoices/{id}","href":"/api-reference/endpoint/invoices/delete"}]},{"group":"Transactions","pages":[{"title":"Create Transaction","openapi":"POST /v1/transactions","href":"/api-reference/endpoint/transactions/create"},{"title":"Update Transaction","openapi":"PATCH /v1/transactions/{id}","href":"/api-reference/endpoint/transactions/update"},{"title":"Delete Transaction","openapi":"DELETE /v1/transactions/{id}","href":"/api-reference/endpoint/transactions/delete"}]}]},{"group":"Atomic Resources","pages":[{"group":"Emails","pages":[{"title":"Create Email","openapi":"POST /v1/emails","href":"/api-reference/endpoint/emails/create-email"},{"title":"Get Emails","openapi":"GET /v1/emails","href":"/api-reference/endpoint/emails/get-emails"},{"title":"Delete Email","openapi":"DELETE /v1/emails/{id}","href":"/api-reference/endpoint/emails/delete-email"},{"title":"Get Email by ID","openapi":"GET /v1/emails/{id}","href":"/api-reference/endpoint/emails/get-email-by-id"}]},{"group":"Phones","pages":[{"title":"Create Phone","openapi":"POST /v1/phones","href":"/api-reference/endpoint/phones/create-phone"},{"title":"Delete Person Phone","openapi":"DELETE /v1/phones/{id}","href":"/api-reference/endpoint/phones/delete-phone"},{"title":"Create Phone Verification Code","openapi":"POST /v1/people/{personId}/phones/{phoneId}/verify/{code}","href":"/api-reference/endpoint/phones/create-phone-verification-code"},{"title":"Verify Phone Number","openapi":"POST /v1/people/{personId}/phones/{phoneId}/verify","href":"/api-reference/endpoint/phones/create-verify-phone-number"}]},{"group":"Documents","pages":[{"title":"Create Document","openapi":"POST /v1/documents","href":"/api-reference/endpoint/documents/create"},{"title":"Get Document by id","openapi":"GET /v1/documents/{id}","description":null,"href":"/api-reference/endpoint/documents/get"},{"title":"Get Document","openapi":"GET /v1/documents","href":"/api-reference/endpoint/documents/get-all"},{"title":"Delete Document","openapi":"DELETE /v1/documents/{id}","description":null,"href":"/api-reference/endpoint/documents/delete"}]},{"group":"Invoice items","pages":[{"title":"Create Invoice items","openapi":"POST /v1/invoice-items","href":"/api-reference/endpoint/invoice-items/post"},{"title":"Delete Invoice items","openapi":"DELETE /v1/invoice-items/{id}","href":"/api-reference/endpoint/invoice-items/delete"},{"title":"Patch Invoice items","openapi":"PATCH /v1/invoice-items/{id}","href":"/api-reference/endpoint/invoice-items/patch"}]},{"group":"Web Links","pages":[{"title":"Create web link","openapi":"POST /v1/web-links","href":"/api-reference/endpoint/web-link/create"},{"title":"Delete web-link","openapi":"Delete /v1/web-links/{id}","href":"/api-reference/endpoint/web-link/delete"},{"title":"Get web-Link","openapi":"Get /v1/web-links","href":"/api-reference/endpoint/web-link/get"},{"title":"Get web-Link by id","openapi":"Get /v1/web-links/{id}","href":"/api-reference/endpoint/web-link/get-by-id"}]},{"group":"Media","pages":[{"title":"Create Media","openapi":"POST /v1/medias","href":"/api-reference/endpoint/media/create"},{"title":"Delete Media","openapi":"DELETE /v1/medias/{id}","href":"/api-reference/endpoint/media/delete"}]},{"group":"Location","pages":[{"title":"Create Location","openapi":"POST /v1/locations","href":"/api-reference/endpoint/location/create"},{"title":"Get Location","openapi":"GET /v1/locations","href":"/api-reference/endpoint/location/get"},{"title":"Get Location by id","openapi":"GET /v1/locations/{id}","href":"/api-reference/endpoint/location/get-by-id"},{"title":"Delete Location","openapi":"DELETE /v1/locations/{id}","href":"/api-reference/endpoint/location/delete"}]},{"group":"Balances","pages":[{"title":"Create Balance","openapi":"POST /v1/balances","href":"/api-reference/endpoint/balances/create"},{"title":"Delete Balance","openapi":"DELETE /v1/balances/{id}","href":"/api-reference/endpoint/balances/delete"}]}]},{"group":"System","pages":[{"group":"API Keys","pages":[{"title":"Create Api-Key","openapi":"POST /v1/api-key","href":"/api-reference/endpoint/api-key/create"},{"title":"Delete Api-Key","openapi":"DELETE /v1/api-key/{id}","href":"/api-reference/endpoint/api-key/delete"}]},{"group":"Workspaces","pages":[{"title":"Create Workspace","openapi":"POST /v1/workspaces","href":"/api-reference/endpoint/workspaces/create"},{"title":"List Workspaces","href":"/api-reference/endpoint/workspaces/get-all"},{"title":"Get Workspace","openapi":"GET /v1/workspaces/{id}","href":"/api-reference/endpoint/workspaces/get"},{"title":"Update Workspace","openapi":"PATCH /v1/workspaces/{id}","href":"/api-reference/endpoint/workspaces/update"},{"title":"Delete Workspace","openapi":"DELETE /v1/workspaces/{id}","href":"/api-reference/endpoint/workspaces/delete"},{"title":"Remove Workspace from Company","openapi":"DELETE /v1/companies/{companyId}/relationships/workspace/{workspaceId}","href":"/api-reference/endpoint/companies/remove-workspace-from-company"}]},{"group":"Memberships","pages":[{"title":"Create Membership","openapi":"POST /v1/memberships","href":"/api-reference/endpoint/memberships/create"},{"title":"Get Membership","openapi":"GET /v1/memberships/{id}","href":"/api-reference/endpoint/memberships/get"},{"title":"Get All Memberships","openapi":"GET /v1/memberships","href":"/api-reference/endpoint/memberships/get-all"},{"title":"Update Membership","openapi":"PATCH /v1/memberships/{id}","href":"/api-reference/endpoint/memberships/update"},{"title":"Delete Membership","openapi":"DELETE /v1/memberships/{id}","href":"/api-reference/endpoint/memberships/delete"}]},{"group":"Webhooks","pages":[{"title":"Create Webhook","openapi":"POST /v1/subscriptions/webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Update Webhook","openapi":"PATCH /v1/subscriptions/webhooks/{id}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Get Webhook","openapi":"GET /v1/subscriptions/webhooks/{id}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Get Webhooks","openapi":"GET /v1/subscriptions/webhooks","href":"/api-reference/endpoint/webhooks/get-all"},{"title":"Delete Webhook","openapi":"DELETE /v1/subscriptions/webhooks/{id}","href":"/api-reference/endpoint/webhooks/delete"}]}]},{"group":"Records — read endpoints","pages":[{"group":"Transactions","pages":[{"title":"List Transactions","openapi":"GET /v1/transactions","href":"/api-reference/endpoint/transactions/get-all"},{"title":"Get Transactions","openapi":"GET /v1/transactions/{id}","href":"/api-reference/endpoint/transactions/get"}]},{"group":"Payment Means","pages":[{"title":"List Payment Means","openapi":"GET /v1/payment-means","href":"/api-reference/endpoint/payment-means/get-all"},{"title":"Get Payment Means","openapi":"GET /v1/payment-means/{id}","href":"/api-reference/endpoint/payment-means/get"}]},{"group":"Account Balances","pages":[{"title":"List Account Balances","openapi":"GET /v1/account-balances","href":"/api-reference/endpoint/account-balances/get-all"},{"title":"Get Account Balances","openapi":"GET /v1/account-balances/{id}","href":"/api-reference/endpoint/account-balances/get"}]},{"group":"Accounts","pages":[{"title":"List Accounts","openapi":"GET /v1/accounts","href":"/api-reference/endpoint/accounts/get-all"},{"title":"Get Accounts","openapi":"GET /v1/accounts/{id}","href":"/api-reference/endpoint/accounts/get"}]},{"group":"Cards","pages":[{"title":"List Cards","openapi":"GET /v1/cards","href":"/api-reference/endpoint/cards/get-all"},{"title":"Get Cards","openapi":"GET /v1/cards/{id}","href":"/api-reference/endpoint/cards/get"}]},{"group":"Checks","pages":[{"title":"List Checks","openapi":"GET /v1/checks","href":"/api-reference/endpoint/checks/get-all"},{"title":"Get Checks","openapi":"GET /v1/checks/{id}","href":"/api-reference/endpoint/checks/get"}]},{"group":"Ledger Accounts","pages":[{"title":"List Ledger Accounts","openapi":"GET /v1/ledger-accounts","href":"/api-reference/endpoint/ledger-accounts/get-all"},{"title":"Get Ledger Accounts","openapi":"GET /v1/ledger-accounts/{id}","href":"/api-reference/endpoint/ledger-accounts/get"}]},{"group":"Journals","pages":[{"title":"List Journals","openapi":"GET /v1/journals","href":"/api-reference/endpoint/journals/get-all"},{"title":"Get Journals","openapi":"GET /v1/journals/{id}","href":"/api-reference/endpoint/journals/get"}]},{"group":"Journal Entries","pages":[{"title":"List Journal Entries","openapi":"GET /v1/journal-entries","href":"/api-reference/endpoint/journal-entries/get-all"},{"title":"Get Journal Entries","openapi":"GET /v1/journal-entries/{id}","href":"/api-reference/endpoint/journal-entries/get"}]},{"group":"Tax Rates","pages":[{"title":"List Tax Rates","openapi":"GET /v1/tax-rates","href":"/api-reference/endpoint/tax-rates/get-all"},{"title":"Get Tax Rates","openapi":"GET /v1/tax-rates/{id}","href":"/api-reference/endpoint/tax-rates/get"}]},{"group":"Exchange Rates","pages":[{"title":"List Exchange Rates","openapi":"GET /v1/exchange-rates","href":"/api-reference/endpoint/exchange-rates/get-all"},{"title":"Get Exchange Rates","openapi":"GET /v1/exchange-rates/{id}","href":"/api-reference/endpoint/exchange-rates/get"}]},{"group":"Invoice Items","pages":[{"title":"List Invoice Items","openapi":"GET /v1/invoice-items","href":"/api-reference/endpoint/invoice-items/get-all"},{"title":"Get Invoice Items","openapi":"GET /v1/invoice-items/{id}","href":"/api-reference/endpoint/invoice-items/get"}]},{"group":"Categories","pages":[{"title":"List Categories","openapi":"GET /v1/categories","href":"/api-reference/endpoint/categories/get-all"},{"title":"Get Categories","openapi":"GET /v1/categories/{id}","href":"/api-reference/endpoint/categories/get"}]},{"group":"Invoice Transactions","pages":[{"title":"List Invoice Transactions","openapi":"GET /v1/invoice-transactions","href":"/api-reference/endpoint/invoice-transactions/get-all"},{"title":"Get Invoice Transactions","openapi":"GET /v1/invoice-transactions/{id}","href":"/api-reference/endpoint/invoice-transactions/get"}]},{"group":"Media","pages":[{"title":"List Media","openapi":"GET /v1/media","href":"/api-reference/endpoint/media/get-all"},{"title":"Get Media","openapi":"GET /v1/media/{id}","href":"/api-reference/endpoint/media/get"}]},{"group":"Phones","pages":[{"title":"List Phones","openapi":"GET /v1/phones","href":"/api-reference/endpoint/phones/get-all"},{"title":"Get Phones","openapi":"GET /v1/phones/{id}","href":"/api-reference/endpoint/phones/get"}]},{"group":"Web Links","pages":[{"title":"List Web Links","openapi":"GET /v1/web-links","href":"/api-reference/endpoint/web-links/get-all"},{"title":"Get Web Links","openapi":"GET /v1/web-links/{id}","href":"/api-reference/endpoint/web-links/get"}]},{"group":"Locations","pages":[{"title":"List Locations","openapi":"GET /v1/locations","href":"/api-reference/endpoint/locations/get-all"},{"title":"Get Locations","openapi":"GET /v1/locations/{id}","href":"/api-reference/endpoint/locations/get"}]},{"group":"Chat Conversations","pages":[{"title":"List Chat Conversations","openapi":"GET /v1/chat-conversations","href":"/api-reference/endpoint/chat-conversations/get-all"},{"title":"Get Chat Conversations","openapi":"GET /v1/chat-conversations/{id}","href":"/api-reference/endpoint/chat-conversations/get"}]},{"group":"Workspace Connectors","pages":[{"title":"List Workspace Connectors","openapi":"GET /v1/workspace-connectors","href":"/api-reference/endpoint/workspace-connectors/get-all"},{"title":"Get Workspace Connectors","openapi":"GET /v1/workspace-connectors/{id}","href":"/api-reference/endpoint/workspace-connectors/get"}]},{"group":"Workspace Connector Sync Logs","pages":[{"title":"List Workspace Connector Sync Logs","openapi":"GET /v1/workspace-connector-sync-logs","href":"/api-reference/endpoint/workspace-connector-sync-logs/get-all"},{"title":"Get Workspace Connector Sync Logs","openapi":"GET /v1/workspace-connector-sync-logs/{id}","href":"/api-reference/endpoint/workspace-connector-sync-logs/get"}]},{"group":"Blueprint Runs","pages":[{"title":"List Blueprint Runs","openapi":"GET /v1/blueprint-runs","href":"/api-reference/endpoint/blueprint-runs/get-all"},{"title":"Get Blueprint Runs","openapi":"GET /v1/blueprint-runs/{id}","href":"/api-reference/endpoint/blueprint-runs/get"}]}]}]},{"tab":"Data Model","icon":"database","pages":[{"title":"Data Model","href":"/object-reference/accounts"}]},{"tab":"Enums","icon":"list","pages":[{"title":"Enums","href":"/enums/banking-transaction-fee"}]},{"tab":"Connectors","icon":"plug","pages":[{"title":"Connectors","href":"/connectors"}]},{"tab":"MCP","icon":"robot","pages":[{"title":"MCP","href":"/mcp/introduction"}]},{"tab":"Graphing library","icon":"palette","pages":[{"title":"Graphing library","href":"/api-reference/graphing-library"}]}]},"title":"Get Document - Well Starter Kit","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}