Search Documents

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

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:

DocumentRead

OAuth 2.0 User Token Scopes:

lucidchart.document.content:readonly
lucidscale.document.content:readonly
lucidspark.document.content:readonly

Body Params

product

array of strings

Defaults to lucidchart,lucidscale,lucidspark

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

product

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.

Language

Credentials


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


xxxxxxxxxx
27
}
1
{
2
  "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",
3
  "title": "document title",
4
  "editUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/edit",
5
  "viewUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/view",
6
  "version": 101,
7
  "pageCount": 5,
8
  "canEdit": false,
9
  "created": "2019-04-22T13:47:23Z",
10
  "creatorId": 12345,
11
  "lastModified": "2020-06-26T16:29:37Z",
12
  "lastModifiedUserId": 54321,
13
  "customAttributes": [],
14
  "customTags": [
15
    "in progress"
16
  ],
17
  "product": "lucidchart",
18
  "status": "Complete",
19
  "classification": "Private",
20
  "trashed": null,
21
  "parent": null,
22
  "owner": {
23
    "id": 123456,
24
    "type": "user",
25
    "name": "John Doe"

📘

📘

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.