Search Folders

Retrieves information about folders the authenticated user has at least read only access to. Additional filtering parameters may be added.

The ability to use this API to search for all account folders is exclusive to Enterprise Shield accounts.

• Only the account owner or a document admin can grant access to the admin version of this API.
• Admins can search all account folders belonging to the requested user's account.

📘

The list of folders returned depends on whether the request was made using user or admin permissions, sorted by created date.

• User: folders the requesting user has access to and matching search parameters
  • Must request with a user grant/scope and either omit the header Lucid-Request-As or contain the value user.
• Admin: folders belonging to the account and matching search parameters
  • Must request with an admin grant/scope and contain the header Lucid-Request-As with value admin.

📘

This endpoint is paginated. For more information, see Pagination .

📘

This endpoint has a per account rate limit of 300 requests per 5 seconds.

Valid Authentication Methods

API Key Grants:

• FolderRead
• FolderAdmin

OAuth 2.0 User Token Scopes:

• folder:readonly
• folder:admin.readonly