Date the document expires. Not set means the document never expires
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pland Developer Platform","colors":{"primary":"#2563EB","light":"#bfdbfe","dark":"#1E40AF"},"logo":{"light":"https://mintcdn.com/pland/4nF818XuJvdH1X-y/logo/logo-light.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=58e21d630b18eebde27bee10fa752eb3","dark":"https://mintcdn.com/pland/4nF818XuJvdH1X-y/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=426b8f2e17759f6cab27a2049c396092"},"favicon":"https://mintcdn.com/pland/4nF818XuJvdH1X-y/favicon.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=118b9198f497329520268b5f9511ff95","navbar":{"links":[{"href":"mailto:support@pland.app","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://cloud.pland.app/login"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/pland-software","youtube":"https://www.youtube.com/@pland.software"}},"seo":{"indexing":"navigable"},"icons":{"library":"fontawesome"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Roadmap","icon":"road","href":"https://feedback.pland.app/de/roadmap/main"},{"anchor":"Changelog","icon":"bullhorn","href":"https://feedback.pland.app/de/changelog"},{"anchor":"Knowledge Base","icon":"book","href":"https://help.pland.app"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pland","hasAudioNarration":false,"actualSubdomain":"pland","customDomains":["docs.pland.app"],"gitSource":{"type":"gitlab","owner":"common-digital","repo":"pland-docs","projectId":71427967,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e72d094e7057e3148df0","collectionId":"72c63d0c-dc7f-4b3f-8b62-95a30f93a70b","schemaVersion":"v2"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aee03c755bb8cace6bce8ab","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":79},{"language":"default","tag":"Documents","count":8},{"language":"default","tag":"Users","count":8},{"language":"default","tag":"Tasks","count":7},{"language":"default","tag":"Customers","count":6},{"language":"default","tag":"Objects","count":6},{"language":"default","tag":"Absences","count":5},{"language":"default","tag":"Articles","count":5},{"language":"default","tag":"Equipment","count":5},{"language":"default","tag":"Quality Control","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"stylse.css","content":".nav-tabs-item:nth-child(3)::after{content:\"Coming soon\";display:inline-block;font-size:.65rem;font-weight:700;line-height:1.25;padding:.125rem .25rem;margin-left:.5rem;border-radius:var(--rounded-md, .375rem);background-color:rgb(var(--primary) / .1)}html.light .nav-tabs-item:nth-child(3)::after{color:rgb(var(--primary-dark))}html.dark .nav-tabs-item:nth-child(3)::after{color:rgb(var(--primary-light))}"}],"page":{"pagePath":"api-reference/documents/list","slug":"/api-reference/documents/list","pageMetadata":{"title":"List Documents","openapi":"GET /documents/","description":"List documents by their IDs. Requires a filter with document IDs.","href":"/api-reference/documents/list"},"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: \"List documents by their IDs. Requires a filter with document IDs.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Documents","openapi":"GET /documents/","description":"List documents by their IDs. Requires a filter with document IDs.","href":"/api-reference/documents/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Documents"],"summary":"List documents by IDs","description":"List documents by their IDs. Requires a filter with document IDs.","operationId":"listDocumentsByIds","parameters":[],"responses":{"200":"8c2be174-c290-46eb-8a21-6ec9b3c847c2","401":"e8188a96-ea7a-4eac-944b-23083e9a94cc","403":"64afc98f-194e-4287-9c95-fae88391570f"},"security":["9cd3393d-bd5b-496a-ad21-f1823f6ecf99","150cf747-607f-48bc-9466-4446238d18e2"],"method":"get","type":"path","servers":["049f04bf-2709-4eaa-8561-4ab663e714af","c9c1a3f9-30ec-4c06-b6dc-9dac055b68a8"],"path":"/documents/","baseUrlOptions":["https://cloud-api.pland.app/v2","https://beta-api.pland.app/v2"],"title":"List documents by IDs","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"8c2be174-c290-46eb-8a21-6ec9b3c847c2":{"description":"List of documents","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","title":"Document","description":"A document represents a file or attachment stored in the system, with metadata and references to related entities.","required":["fileName","accessGroup"],"properties":{"fileName":{"description":"Original file name","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].fileName","typeLabel":"string"},"accessGroup":{"description":"Access group for the document (e.g. service, objectmanager)","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].accessGroup","typeLabel":"string"},"_id":{"description":"Unique identifier of the entity","type":"string","format":"objectid","uniqueKey":"items.[INDEX]._id","typeLabel":"string\u003cobjectid>"},"number":{"description":"Unique number of the entity, used for identification","type":"integer","uniqueKey":"items.[INDEX].number","typeLabel":"integer"},"companyId":{"description":"The ID of the company this entity belongs to","type":"string","format":"objectid","x-internal":true,"uniqueKey":"items.[INDEX].companyId","typeLabel":"string\u003cobjectid>"},"status":{"description":"Entity Status information","properties":{"status":{"description":"Current status","type":"integer","uniqueKey":"items.[INDEX].status.status","typeLabel":"integer"},"createdAt":{"description":"Creation timestamp","type":"string","format":"date-time","uniqueKey":"items.[INDEX].status.createdAt","typeLabel":"string\u003cdate-time>"},"createdBy":{"description":"User who created this supplier","type":"string","format":"objectid","uniqueKey":"items.[INDEX].status.createdBy","typeLabel":"string\u003cobjectid>"},"lastModifiedAt":{"description":"Last modification timestamp","type":"string","format":"date-time","uniqueKey":"items.[INDEX].status.lastModifiedAt","typeLabel":"string\u003cdate-time>"},"lastModifiedBy":{"description":"User who last modified this supplier","type":"string","format":"objectid","uniqueKey":"items.[INDEX].status.lastModifiedBy","typeLabel":"string\u003cobjectid>"},"agentId":{"oneOf":[{"description":"Agent that created or modified this entity","type":"string","format":"objectid","uniqueKey":"items.[INDEX].status.agentId.oneOf.0","typeLabel":"string\u003cobjectid>"},{"description":"Agent that created or modified this entity","type":"null","format":"objectid","uniqueKey":"items.[INDEX].status.agentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].status.agentId","typeLabel":"string\u003cobjectid> | null"},"assistantId":{"oneOf":[{"description":"Text assistant that created or modified this entity on behalf of a user","type":"string","format":"objectid","uniqueKey":"items.[INDEX].status.assistantId.oneOf.0","typeLabel":"string\u003cobjectid>"},{"description":"Text assistant that created or modified this entity on behalf of a user","type":"null","format":"objectid","uniqueKey":"items.[INDEX].status.assistantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].status.assistantId","typeLabel":"string\u003cobjectid> | null"}},"type":"object","uniqueKey":"items.[INDEX].status","typeLabel":"object"},"url":{"description":"URL to access the document file","type":"string","uniqueKey":"items.[INDEX].url","typeLabel":"string"},"name":{"description":"Display name of the document","type":"string","uniqueKey":"items.[INDEX].name","typeLabel":"string"},"objectId":{"description":"Related object ID","type":"string","format":"objectid","uniqueKey":"items.[INDEX].objectId","typeLabel":"string\u003cobjectid>"},"userId":{"description":"Related user ID","type":"string","format":"objectid","uniqueKey":"items.[INDEX].userId","typeLabel":"string\u003cobjectid>"},"jobId":{"description":"Related job ID","type":"string","format":"objectid","uniqueKey":"items.[INDEX].jobId","typeLabel":"string\u003cobjectid>"},"customerId":{"description":"Related customer ID","type":"string","format":"objectid","uniqueKey":"items.[INDEX].customerId","typeLabel":"string\u003cobjectid>"},"absenceId":{"description":"Related absence ID","type":"string","format":"objectid","uniqueKey":"items.[INDEX].absenceId","typeLabel":"string\u003cobjectid>"},"equipmentId":{"description":"Related equipment ID","type":"string","format":"objectid","uniqueKey":"items.[INDEX].equipmentId","typeLabel":"string\u003cobjectid>"},"taskId":{"description":"Related task ID","type":"string","format":"objectid","uniqueKey":"items.[INDEX].taskId","typeLabel":"string\u003cobjectid>"},"taskTemplateId":{"description":"Related task template ID","type":"string","format":"objectid","uniqueKey":"items.[INDEX].taskTemplateId","typeLabel":"string\u003cobjectid>"},"formId":{"oneOf":[{"description":"Form id this PDF was generated from (server-controlled)","type":"string","format":"objectid","uniqueKey":"items.[INDEX].formId.oneOf.0","typeLabel":"string\u003cobjectid>"},{"description":"Form id this PDF was generated from (server-controlled)","type":"null","format":"objectid","uniqueKey":"items.[INDEX].formId.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].formId","typeLabel":"string\u003cobjectid> | null"},"uploadId":{"description":"Upload process ID","type":"string","format":"objectid","uniqueKey":"items.[INDEX].uploadId","typeLabel":"string\u003cobjectid>"},"aiAnalysis":{"oneOf":[{"type":"object","title":"AI Analysis","description":"AI-generated structured document analysis from Gemini vision extraction","required":["status"],"properties":{"status":{"description":"Analysis lifecycle: in_progress, completed, or failed","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].aiAnalysis.oneOf.0.status","typeLabel":"string"},"error":{"description":"Error message when status is failed","type":"string","uniqueKey":"items.[INDEX].aiAnalysis.oneOf.0.error","typeLabel":"string"},"documentType":{"description":"Document type (e.g. invoice, timesheet, service_specification, offer, contract, letter)","type":"string","uniqueKey":"items.[INDEX].aiAnalysis.oneOf.0.documentType","typeLabel":"string"},"summary":{"description":"Short 2-3 sentence summary of the document content","type":"string","uniqueKey":"items.[INDEX].aiAnalysis.oneOf.0.summary","typeLabel":"string"},"keyFacts":{"description":"Key facts as key-value pairs (e.g. sender, recipient, date, total)","type":"object","additionalProperties":{"type":"string","uniqueKey":"items.[INDEX].aiAnalysis.oneOf.0.keyFacts.additionalProperties","typeLabel":"string"},"uniqueKey":"items.[INDEX].aiAnalysis.oneOf.0.keyFacts","typeLabel":"object"},"fullExtraction":{"description":"Full structured extraction of all document content","type":"string","uniqueKey":"items.[INDEX].aiAnalysis.oneOf.0.fullExtraction","typeLabel":"string"}},"uniqueKey":"items.[INDEX].aiAnalysis.oneOf.0","typeLabel":"AI Analysis · object"},{"type":"null","uniqueKey":"items.[INDEX].aiAnalysis.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].aiAnalysis","typeLabel":"AI Analysis · object | null"},"emailMessageId":{"oneOf":[{"description":"EmailMessage id this document was linked from (server-controlled)","type":"string","format":"objectid","uniqueKey":"items.[INDEX].emailMessageId.oneOf.0","typeLabel":"string\u003cobjectid>"},{"description":"EmailMessage id this document was linked from (server-controlled)","type":"null","format":"objectid","uniqueKey":"items.[INDEX].emailMessageId.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].emailMessageId","typeLabel":"string\u003cobjectid> | null"},"emailAttachmentId":{"oneOf":[{"description":"Nylas attachment id this document was linked from (server-controlled)","type":"string","uniqueKey":"items.[INDEX].emailAttachmentId.oneOf.0","typeLabel":"string"},{"description":"Nylas attachment id this document was linked from (server-controlled)","type":"null","uniqueKey":"items.[INDEX].emailAttachmentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].emailAttachmentId","typeLabel":"string | null"},"tags":{"oneOf":[{"description":"Free-form tags of the document","type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"items.[INDEX].tags.oneOf.0","typeLabel":"string[]"},{"description":"Free-form tags of the document","type":"null","items":{"type":"string"},"uniqueKey":"items.[INDEX].tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].tags","typeLabel":"string[] | null"},"expiresAt":{"oneOf":[{"description":"Date the document expires. Not set means the document never expires","type":"string","format":"date-time","uniqueKey":"items.[INDEX].expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Date the document expires. Not set means the document never expires","type":"null","format":"date-time","uniqueKey":"items.[INDEX].expiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].expiresAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"items.[INDEX]","typeLabel":"Document · object"},"uniqueKey":"","typeLabel":"Document · object[]"},"examples":{"Example":{"title":"Example","value":[{"fileName":"\u003cstring>","accessGroup":"\u003cstring>","_id":"\u003cstring>","number":123,"companyId":"\u003cstring>","status":{"status":123,"createdAt":"2023-11-07T05:31:56Z","createdBy":"\u003cstring>","lastModifiedAt":"2023-11-07T05:31:56Z","lastModifiedBy":"\u003cstring>","agentId":"\u003cstring>","assistantId":"\u003cstring>"},"url":"\u003cstring>","name":"\u003cstring>","objectId":"\u003cstring>","userId":"\u003cstring>","jobId":"\u003cstring>","customerId":"\u003cstring>","absenceId":"\u003cstring>","equipmentId":"\u003cstring>","taskId":"\u003cstring>","taskTemplateId":"\u003cstring>","formId":"\u003cstring>","uploadId":"\u003cstring>","aiAnalysis":{"status":"\u003cstring>","error":"\u003cstring>","documentType":"\u003cstring>","summary":"\u003cstring>","keyFacts":{},"fullExtraction":"\u003cstring>"},"emailMessageId":"\u003cstring>","emailAttachmentId":"\u003cstring>","tags":["\u003cstring>"],"expiresAt":"2023-11-07T05:31:56Z"}]}},"exampleType":"generated"}},"exampleType":"generated"},"e8188a96-ea7a-4eac-944b-23083e9a94cc":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"64afc98f-194e-4287-9c95-fae88391570f":{"description":"Forbidden","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"9cd3393d-bd5b-496a-ad21-f1823f6ecf99":{"API-Key":{"type":"apiKey","name":"x-API-Key","in":"header","scopes":[],"schemeName":"API-Key"}},"150cf747-607f-48bc-9466-4446238d18e2":{"Bearer-Auth":{"type":"http","bearerFormat":"JWT","scheme":"bearer","scopes":[],"schemeName":"Bearer-Auth"}}},"servers":{"049f04bf-2709-4eaa-8561-4ab663e714af":{"url":"https://cloud-api.pland.app/v2","description":"Production Server"},"c9c1a3f9-30ec-4c06-b6dc-9dac055b68a8":{"url":"https://beta-api.pland.app/v2","description":"Sandbox Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-API-Key","in":"header","scopes":[],"schemeName":"API-Key"},"schema":{"title":"x-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"API-Key","name":"x-API-Key"}],"title":"API-Key"},{"schemes":[{"scheme":{"type":"http","bearerFormat":"JWT","scheme":"bearer","scopes":[],"schemeName":"Bearer-Auth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer-Auth","name":"Authorization"}],"title":"Bearer-Auth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"pland","siteName":"Pland Developer Platform","title":"List Documents - Pland Developer Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-17T11:03:32.112Z","originalFileLocation":"api-reference/documents/list.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=\"List documents by their IDs. Requires a filter with document IDs.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pland Developer Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Documents - Pland Developer Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"List documents by their IDs. Requires a filter with document IDs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pland Developer Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pland.app/api-reference/documents/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pland.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=List+Documents\u0026amp;description=List+documents+by+their+IDs.+Requires+a+filter+with+document+IDs.\u0026amp;theme=79a9502ef2604cadbd145a60\u0026amp;signature=6c9c737e521abd53f243b092708216ee623255972c3180205bcaeb027863a509\">\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 - Pland Developer Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List documents by their IDs. Requires a filter with document IDs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pland.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=List+Documents\u0026amp;description=List+documents+by+their+IDs.+Requires+a+filter+with+document+IDs.\u0026amp;theme=79a9502ef2604cadbd145a60\u0026amp;signature=6c9c737e521abd53f243b092708216ee623255972c3180205bcaeb027863a509\">\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/pland/T_oVkU3Prt9hFyNK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pland Developer Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pland.app/api-reference/documents/list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/documents/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pland.app/#organization\",\"name\":\"Pland Developer Platform\",\"url\":\"https://docs.pland.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pland/4nF818XuJvdH1X-y/logo/logo-light.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=58e21d630b18eebde27bee10fa752eb3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pland.app#website\",\"name\":\"Pland Developer Platform\",\"url\":\"https://docs.pland.app\",\"publisher\":{\"@id\":\"https://docs.pland.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pland.app/api-reference/documents/list#webpage\",\"url\":\"https://docs.pland.app/api-reference/documents/list\",\"name\":\"List Documents\",\"description\":\"List documents by their IDs. Requires a filter with document IDs.\",\"dateModified\":\"2025-11-17T11:03:32.112Z\",\"isPartOf\":{\"@id\":\"https://docs.pland.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pland.app/api-reference/documents/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pland.app/api-reference/documents/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pland Developer Platform\",\"item\":\"https://docs.pland.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Documents\",\"item\":\"https://docs.pland.app/api-reference/documents/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pland.app/api-reference/documents/list#apireference\",\"headline\":\"List Documents\",\"name\":\"List Documents\",\"description\":\"List documents by their IDs. Requires a filter with document IDs.\",\"url\":\"https://docs.pland.app/api-reference/documents/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pland.app/api-reference/documents/list#webpage\"},\"dateModified\":\"2025-11-17T11:03:32.112Z\",\"publisher\":{\"@id\":\"https://docs.pland.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pland.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pland Developer Platform\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Pland Developer Platform","nav":{"global":{"anchors":[{"anchor":"Roadmap","icon":"road","href":"https://feedback.pland.app/de/roadmap/main"},{"anchor":"Changelog","icon":"bullhorn","href":"https://feedback.pland.app/de/changelog"},{"anchor":"Knowledge Base","icon":"book","href":"https://help.pland.app"}]},"tabs":[{"tab":"Introduction","hidden":false,"pages":[{"title":"Introduction","href":""}]},{"tab":"API Reference","hidden":false,"groups":[{"group":"Getting Started","pages":[{"title":"Authentication","href":"/api-reference/getting-started/authentication"},{"title":"Pagination","href":"/api-reference/getting-started/pagination"},{"title":"Sorting","href":"/api-reference/getting-started/sorting"}]},{"group":"Users","pages":[{"title":"List Users","openapi":"GET /users/","href":"/api-reference/users/list"},{"title":"Get User","openapi":"GET /users/{id}","href":"/api-reference/users/get"},{"title":"Get User by Number","openapi":"GET /users/{userNumber}/byNumber","href":"/api-reference/users/get-by-number"},{"title":"Get Last Number","openapi":"GET /users/lastNumber","href":"/api-reference/users/get-last-number"},{"title":"Create User","openapi":"POST /users/","href":"/api-reference/users/create"},{"title":"Delete User","openapi":"DELETE /users/{id}","href":"/api-reference/users/delete"},{"title":"Update User","openapi":"PATCH /users/{id}","href":"/api-reference/users/update"},{"title":"Send Invite SMS to User","openapi":"POST /users/{id}/generatePassword","href":"/api-reference/users/send-invite-sms"}]},{"group":"Salaries","pages":[{"title":"List Salaries","openapi":"GET /salaries/","href":"/api-reference/salaries/list"},{"title":"Export Salary Rows","openapi":"POST /salaries/exportSalaryRows","href":"/api-reference/salaries/export-rows"}]},{"group":"Jobs","pages":[{"title":"List Open Jobs","openapi":"GET /jobs/notAssigned","href":"/api-reference/jobs/list-open"},{"title":"List Jobs in Timeframe","openapi":"POST /jobs/jobsInTimeFrame","href":"/api-reference/jobs/list-in-timeframe"},{"title":"Update a Job","openapi":"PATCH /jobs/{id}/v2","href":"/api-reference/jobs/update"}]},{"group":"Time Tracking","pages":[{"title":"List Time Trackings","openapi":"GET /timetracking/list","href":"/api-reference/time-tracking/list"}]},{"group":"Objects","pages":[{"title":"List Objects","openapi":"GET /objects/","href":"/api-reference/objects/list"},{"title":"Get Object","openapi":"GET /objects/{id}","href":"/api-reference/objects/get"},{"title":"Get Object by Number","openapi":"GET /objects/{objectNumber}/byNumber","href":"/api-reference/objects/get-by-number"},{"title":"Get Last Number","openapi":"GET /objects/lastNumber","href":"/api-reference/objects/get-last-number"},{"title":"Create Object","openapi":"POST /objects/","href":"/api-reference/objects/create"},{"title":"Update Object","openapi":"PATCH /objects/{id}","href":"/api-reference/objects/update"}]},{"group":"Customers","pages":[{"title":"List Customers","openapi":"GET /customers/","href":"/api-reference/customers/list"},{"title":"Get Customer","openapi":"GET /customers/{id}","href":"/api-reference/customers/get"},{"title":"Get Last Customer Number","openapi":"GET /customers/lastNumber","href":"/api-reference/customers/get-last-number"},{"title":"Create Customer","openapi":"POST /customers/","href":"/api-reference/customers/create"},{"title":"Update Customer","openapi":"PATCH /customers/{id}","href":"/api-reference/customers/update"},{"title":"Batch Update Customers","openapi":"PATCH /customers/many","href":"/api-reference/customers/batch-update"}]},{"group":"Equipment","pages":[{"title":"List Equipment","openapi":"GET /equipment/","href":"/api-reference/equipment/list"},{"title":"Get Equipment","openapi":"GET /equipment/{id}","href":"/api-reference/equipment/get"},{"title":"Create Equipment","openapi":"POST /equipment/","href":"/api-reference/equipment/create"},{"title":"Update Equipment","openapi":"PATCH /equipment/{id}","href":"/api-reference/equipment/update"},{"title":"Batch Update Equipment","openapi":"PATCH /equipment/many","href":"/api-reference/equipment/batch-update"}]},{"group":"Articles","pages":[{"title":"List Articles","openapi":"GET /articles/","href":"/api-reference/articles/list"},{"title":"Get Article","openapi":"GET /articles/{id}","href":"/api-reference/articles/get"},{"title":"Get Last Number","openapi":"GET /articles/lastNumber","href":"/api-reference/articles/get-last-number"},{"title":"Create Article","openapi":"POST /articles/","href":"/api-reference/articles/create"},{"title":"Update Article","openapi":"PATCH /articles/{id}","href":"/api-reference/articles/update"}]},{"group":"Tasks","pages":[{"title":"List Tasks","openapi":"GET /tasks/","href":"/api-reference/tasks/list"},{"title":"Get Task","openapi":"GET /tasks/{id}","href":"/api-reference/tasks/get"},{"title":"Complete Task","openapi":"POST /tasks/{id}/complete","href":"/api-reference/tasks/complete"},{"title":"Create Task","openapi":"POST /tasks/","href":"/api-reference/tasks/create"},{"title":"Update Task","openapi":"PATCH /tasks/{id}","href":"/api-reference/tasks/update"},{"title":"Delete Tasks","openapi":"POST /tasks/delete","href":"/api-reference/tasks/delete"},{"title":"Task forms","openapi":"GET /tasks/{id}/forms","href":"/api-reference/tasks/get-task-forms"}]},{"group":"Task Types","pages":[{"title":"List Task Types","openapi":"GET /taskTypes/","href":"/api-reference/task-types/list"},{"title":"Get Task Type","openapi":"GET /taskTypes/{id}","href":"/api-reference/task-types/get"},{"title":"Create Task Type","openapi":"POST /taskTypes/","href":"/api-reference/task-types/create"},{"title":"Update Task Type","openapi":"PATCH /taskTypes/{id}","href":"/api-reference/task-types/update"},{"title":"Delete Task Type","openapi":"DELETE /taskTypes/{id}","href":"/api-reference/task-types/delete"}]},{"group":"Absences","pages":[{"title":"List Absences","openapi":"GET /absences/","href":"/api-reference/absences/list"},{"title":"Get Absence","openapi":"GET /absences/{id}","href":"/api-reference/absences/get"},{"title":"Create Absence","openapi":"POST /absences/","href":"/api-reference/absences/create"},{"title":"Update Absence","openapi":"PATCH /absences/{id}","href":"/api-reference/absences/update"},{"title":"List Personal Absences","openapi":"GET /absences/self","href":"/api-reference/absences/list-self"}]},{"group":"Material Orders","pages":[{"title":"List Material Orders","openapi":"GET /orders/","href":"/api-reference/material-orders/list"},{"title":"Get Material Order","openapi":"GET /orders/{id}","href":"/api-reference/material-orders/get"},{"title":"Create Material Order","openapi":"POST /objects/{objectId}/order","href":"/api-reference/material-orders/create"},{"title":"Update Material Order","openapi":"PATCH /orders/{id}","href":"/api-reference/material-orders/update"}]},{"group":"Quality Control","pages":[{"title":"List Quality Controls","openapi":"GET /qualityControl/","href":"/api-reference/quality-control/list"},{"title":"Get Quality Control","openapi":"GET /qualityControl/{id}","href":"/api-reference/quality-control/get"},{"title":"Create Quality Control","openapi":"POST /qualityControl/","href":"/api-reference/quality-control/create"},{"title":"List Quality Control by Object","openapi":"GET /qualityControl/object/{objectId}","href":"/api-reference/quality-control/list-by-object"},{"title":"List Quality Control by Object Manager","openapi":"GET /qualityControl/objectManager/{id}","description":"List all quality control entries for a specific object manager. This endpoint returns quality assessments created by the specified object manager.","href":"/api-reference/quality-control/list-by-object-manager"}]},{"group":"Documents","pages":[{"title":"List Documents","openapi":"GET /documents/","href":"/api-reference/documents/list"},{"title":"Get Document","openapi":"GET /documents/{id}","description":"Retrieve a document by its unique identifier.","href":"/api-reference/documents/get"},{"title":"Upload Documents","openapi":"POST /documents/","href":"/api-reference/documents/create"},{"title":"Update Document","openapi":"PATCH /documents/{id}","href":"/api-reference/documents/update"},{"title":"Delete Document","openapi":"DELETE /documents/{id}","href":"/api-reference/documents/delete"},{"title":"List Documents for Entity","openapi":"GET /{entity}/{id}/documents","href":"/api-reference/documents/list-by-entity"},{"title":"Create Document from URL","openapi":"POST /documents/withUrl","href":"/api-reference/documents/create-from-url"},{"title":"Get document tags","openapi":"GET /documents/tags","href":"/api-reference/documents/get-document-tags"}]},{"group":"Logbuch","pages":[{"title":"Send Message","openapi":"POST /chat/v2/{id}/send","href":"/api-reference/logbuch/send-message"},{"title":"Send Note","openapi":"POST /chat/v2/{id}/sendNote","href":"/api-reference/logbuch/send-note"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","openapi":"GET /integrations/webhooks/","href":"/api-reference/webhooks/list"},{"title":"Create Webhook","openapi":"POST /integrations/webhooks/","href":"/api-reference/webhooks/create"},{"title":"Update Webhook","openapi":"PATCH /integrations/webhooks/{id}","href":"/api-reference/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /integrations/webhooks/{id}","href":"/api-reference/webhooks/delete"}]}]},{"tab":"Guides"}]},"basePath":"","title":"List Documents - Pland Developer Platform","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}