Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Document Access

Search Documents

post/v1/documents/search

Request body

productProduct[]

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

createdStartTimestring date-time

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

createdEndTimestring date-time

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

lastModifiedAfterstring date-time

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

keywordsstring

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.

excludeTrashedboolean

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'repositories'

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

Example request

{
  "product": [
    "lucidchart"
  ]
}

Response

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

documentIdstring uuid required

Unique ID of the document

titlestring required

Title of the document

editUrlstring uri required

Link to edit the document

viewUrlstring uri required

Link to view the document

versioninteger required

Most recent version

pageCountinteger required

Number of pages within the document

canEditboolean required

If requesting user can edit the document

createdstring date-time required

Date and time of when the document was created

creatorIdinteger required

ID of user who created and owns the document

lastModifiedstring date-time required

Date and time of when the document was last modified

lastModifiedUserIdinteger required

ID of user who most recently modified the document

customTagsstring[] required

List of any custom tags assigned to the document

product'lucidchart' | 'lucidscale' | 'lucidspark' required

The Lucid Suite product that a document was created in.

statusstring nullable

Current assigned status of the document

classificationstring nullable

Current assigned classification of the document

classificationIdstring uuid nullable

Current assigned classification ID of the document.

trashedstring date-time nullable

If defined, the timestamp when the document was moved to the trash

parentinteger nullable

ID of the parent folder

accountIdinteger nullable required

ID of Lucid account that owns the document

Example response

[
  {
    "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",
    "title": "document title",
    "editUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/edit",
    "viewUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/view",
    "version": 101,
    "pageCount": 5,
    "canEdit": false,
    "created": "2019-04-22T13:47:23Z",
    "creatorId": 12345,
    "lastModified": "2020-06-26T16:29:37Z",
    "lastModifiedUserId": 54321,
    "customAttributes": [],
    "customTags": [
      "in progress"
    ],
    "product": "lucidchart",
    "status": "Complete",
    "classification": "Private",
    "trashed": null,
    "parent": null,
    "repository": null,
    "owner": {
      "id": 123456,
      "type": "user",
      "name": "John Doe"
    },
    "accountId": 1234
  }
]