Search Documents

post

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

Retrieves information about documents that 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.

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

Valid Access Token Types

User

Valid Access Scopes

lucidchart.document.content:readonly

lucidscale.document.content:readonly

lucidspark.document.content:readonly

Body Params

product

array of objects

Defaults to lucidchart,lucidscale,lucidspark

Array of Lucid Suite products to filter by. Default value assumes all valid products for the given scopes.

product

Allowed:

createdStartTime

date-time

Defaults to 0001-01-01T00:00:00Z

Date and time to filter documents that have been created after. Default value assumes the beginning of time.

createdEndTime

date-time

Defaults to now

Date and time to filter documents that have been created before. Default value assumes the current instant of time.

lastModifiedAfter

date-time

Defaults to now

Date and time to filter documents that have been modified after. Default value assumes the beginning of time.

keywords

string

Keywords to search against document 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.

Responses

400

Bad Request if the request does not contain a body.

403

Forbidden if the product query parameter is used and the token's scopes do not contain the matching readonly scope for each product.

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 Document Resource objects containing information about documents the authenticated user has access to.