Drive

list-drive-documents-tool

Find drive documents by title, owner or folder, so you have an id to read or update.

Returns a paginated list of the drive documents the authenticated user can see. This is the entry point to the drive family: every other tool takes a document_id, and this is how you get one.

Omit every owner filter to search everything the user can reach. Bodies are never returned here — use get-drive-document-tool once you know which document you want.

search matches the title only. Document bodies are not indexed and cannot be searched, so narrow by customer, project or folder rather than guessing at the wording inside a document.

Inputs

NameTypeRequiredDescription
searchstringnoCase-insensitive substring match on the title.
customer_idintegernoDocuments owned by this customer or by any project under it.
project_idintegernoDocuments owned by this project.
personalbooleannoDocuments in the caller's own personal drive.
organizationbooleannoDocuments in the organisation-wide drive.
folder_idintegernoDocuments directly inside this folder.
root_onlybooleannoOnly documents that sit outside any folder.
documents_onlybooleannoExclude uploaded files. Default true.
limitintegernoPage size, 1–100, default 25.
offsetintegernoNumber of rows to skip, default 0.

Permissions

The caller needs the drive access permission for at least one owner type (project_drive::access, customer_drive::access, organization_drive::access or user_drive::access); holding none returns an authorization error. Results are then filtered document by document, so a restricted document the caller has no grant on is neither listed nor counted in total.

Example

{
  "project_id": 7,
  "search": "onboarding"
}

Response

{
  "data": [
    {
      "id": 55,
      "title": "Onboarding guide",
      "kind": "document",
      "source": "builtin",
      "access": "edit",
      "owner": { "type": "project", "id": 7, "name": "ACME website" },
      "folder": { "id": 12, "name": "Drafts", "path": "Docs/Specs/Drafts" },
      "url": "https://acme.plnnrly.com/projects/7?documentId=55",
      "tags": ["handbook"],
      "created_at": "2026-08-01T09:12:00+00:00",
      "updated_at": "2026-08-19T15:40:11+00:00"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 25,
    "offset": 0,
    "has_more": false,
    "truncated": false
  }
}

access is "view" or "edit" and tells you in advance whether update-drive-document-tool will be accepted. url is null for documents owned by the organisation or a personal drive.

truncated is true when more than 2000 documents matched before permission filtering, which means total is an undercount. Narrow the query by customer, project or folder when you see it.

Errors

  • A caller with no drive access permission at all returns an authorization error.
  • An out-of-range limit (less than 1 or greater than 100) returns a validation error.

On this page