Search Folders

post

https://api.lucid.co/folders/search

Retrieves information about folders the authenticated user has at least read only access to. Additional filtering parameters may be added.This endpoint is paginated. For more information, see Pagination. It supports only User token type.

Valid Access Token Types

User

Valid Access Scopes

folder:readonly

Body Params

type

string

enum

Note: This endpoint only accepts the folder type

Allowed:

userIds

array of numbers

List of userIds to include in search. If no ids are provided it will search across the entire account.

userIds

ownedByUsers

boolean

Truthy if search results should only include documents owned by users specified by userIds. Ignored if no userIds are provided.

keywords

string

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.

Headers

Lucid-Api-Version

string

required

Defaults to 1

The API version used in the request.

Lucid-Request-As

string

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.

Responses

400

Bad Request if the request does not contain a body.

403

Forbidden if User requests with admin scope and without Lucid-Request-As=admin header, User requests without an admin scope and includes Lucid-Request-As=admin header, or Account does not have access to the API

429

Too Many Requests if the account makes more than 300 requests in 5 seconds.

Valid Access Token Types

Valid Access Scopes

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