v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB

Folders

Search Folders

Retrieves information about folders the authenticated user has at least read-only access to. Admin requests using the Lucid-Request-As: admin header return all account folders; this capability is exclusive to Enterprise Shield accounts. Results are sorted by creation date and paginated. Rate limited to 300 requests per 5 seconds per account.

post/v1/folders/search

Headers

Lucid-Request-Asstring required

If the requesting user is an account owner or folder admin with the required permissions and they make the request with the value of “admin” as this header and include an admin scope, the request will be made using their admin permissions. Account owners and document admins can access the admin version of folder search.

Request body

type'folder' | 'team'

folder - Folders can live in other folders, team folders, or the root of a user’s folder manager ("My Documents"). A folder in "My Documents" will have a null parent field.
team - Team folders can never live in another folder and are always located in the "Team Folders" section of a user's folder manager. Team folders will not have a parent field. Learn more

userIdsnumber[]

If provided, limit the search to folders that at least one specified user can access. Without a list, the system searches the entire account (admin-level) or only folders the authenticated user can access (user-level).

ownedByUsersboolean

When true, search results will only include folders owned by users specified by userIds. Ignored if no userIds are provided.

keywordsstring

Keywords to search against folder content and titles. This field is truncated to 400 characters. When provided, results will be sorted by relevance to keyword search.

appFolderboolean

When set to true, restricts search results to folders within the OAuth2 client's app project folder. Required when using a document.app.folder scope without a folder:readonly scope.

Example request

{
  "type": "folder"
}

Response

OK with an array of Folder Resource objects containing information about folders the authenticated user has access to.

idnumber required

Unique ID of the folder

type'folder' | 'team' required

folder - Folders can live in other folders, team folders, or the root of a user’s folder manager ("My Documents"). A folder in "My Documents" will have a null parent field.
team - Team folders can never live in another folder and are always located in the "Team Folders" section of a user's folder manager. Team folders will not have a parent field. Learn more

namestring required

Name of the folder

parentnumber nullable

ID of the parent folder.

createdstring date-time required

Date and time of when the folder was created

trashedstring date-time

Date and time of when the folder was trashed

Example response

[
  {
    "id": 123456789,
    "type": "folder",
    "name": "Folder Name",
    "parent": 123456788,
    "created": "2020-06-26T16:29:37Z",
    "trashed": "2022-01-20T12:14:18Z",
    "attributes": [
      {
        "name": "Sample Label",
        "value": "Sample Value"
      }
    ]
  }
]