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.

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

Body Params

type

string

Note: This endpoint only accepts the folder type

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.

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.lucid.co/folders/search \
3
     --header 'Lucid-Api-Version: 1' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'


xxxxxxxxxx
16
 
1
[
2
  {
3
    "id": 123456789,
4
    "type": "folder",
5
    "name": "Folder Name",
6
    "parent": 123456788,
7
    "created": "2020-06-26T16:29:37Z",
8
    "trashed": "2022-01-20T12:14:18Z",
9
    "attributes": [
10
      {
11
        "name": "Sample Label",
12
        "value": "Sample Value"
13
      }
14
    ]
15
  }
16
]

📘

📘

📘

Valid Authentication Methods

API Key Grants:

OAuth 2.0 User Token Scopes:

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