Search Documents

post

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

Search Documents and Search Account Documents share a per-account rate limit.

Retrieves information about documents that the authenticated user has at least read only access to.

By default, documents are sorted by created date from oldest to newest. Providing the keywords parameter will cause the documents to be sorted by relevance instead.

📘
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:

DocumentReadonly

OAuth 2.0 User Token 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 9999-12-31T23:59:59Z

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

lastModifiedAfter

date-time

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

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

lastModifiedBefore

date-time

Date and time to filter documents that have been modified before. When omitted, results are not bounded by an upper modified-time limit.

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.

excludeTrashed

boolean

Defaults to false

When set to true, excludes trashed/deleted documents from search results. When set to false or omitted, trashed documents are included in results with their trashedTimestamp populated.

documentLocation

string

enum

When provided, restricts search results to documents contained within repositories the authenticated user can access. Only the value "repositories" is supported on this endpoint.

Allowed:

owners

array of numbers

When provided, limit the search to documents owned by at least one of the specified users. Results are still restricted to documents the authenticated user can access. A maximum of 10000 users may be specified.

owners

externalAccess

string

enum

Specify to search for documents with either “any” type of external access, “external-collaborators”, or "external-links"

Allowed:

statusIds

array of numbers

List of statusIds to filter by.

statusIds

documentIds

array of uuids

List of documentIds to filter by. A maximum of 10000 documents may be specified.

documentIds

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.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

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:

OAuth 2.0 User Token Scopes:

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

429Too Many Requests if the account exceeds the shared limit of 300 document searches per 5 seconds.