LUlucid
Document Access

Search Account Documents

Changed on

Returns a list of all documents belonging to the requesting user's account, sorted by created date. This API is exclusive to Enterprise Shield accounts. The endpoint supports pagination. Search Documents and Search Account Documents share a limit of 300 requests per 5 seconds per account.

post/v2/accounts/me/documents/search

Request

  • Base URL
    https://api.lucid.co
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization codehttps://lucid.app/oauth2/authorize
      Token URLhttps://api.lucid.co/oauth2/token
      Scopeslucidchart.document.content:admin.readonly, lucidspark.document.content:admin.readonly, lucidscale.document.content:admin.readonly
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Headers

Lucid-Request-Asstring required

If the requesting user is an account owner or document 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.

Request body

userIdsnumber[]

When provided, limit the search to documents that at least one specified user can access. If no list is provided, search across the entire account.

ownedByUsersboolean

When true, search results will only include documents owned by users specified by userIds. Ignored if no userIds are provided.

documentIdsstring[]

List of documentIds to filter by.

classificationIdsstring[]

List of classificationIds to filter by.

statusIdsnumber[]

List of statusIds to filter by.

createdStartTimestring date-time

Start of range to filter documents by created time.

createdEndTimestring date-time

End of range to filter documents by created time.

lastModifiedStartTimestring date-time

Start of range to filter documents by last modified time.

lastModifiedEndTimestring date-time

End of range to filter documents by last modified time.

productProduct[]

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

keywordsstring

Keyword(s) to search against document content and titles. When provided, results will be sorted by relevance to keyword search. Use quotes to search for exact phrases (e.g. "Project X")

documentLocation'team folders' | 'users' | 'deleted' | 'repositories'

Specify to search for documents in team folders, owned by users, deleted, or contained within repositories

externalAccess'any' | 'external-collaborators' | 'external-links'

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

Example request

{
  "product": [
    "lucidchart"
  ]
}

Response

With paginated list of Account Documents

documentIdstring uuid required

Unique ID of the document

titlestring required

Title of the document

adminViewUrlstring uri required

Link to view the document

createdstring date-time required

Date and time of when the document was created

lastModifiedstring date-time required

Date and time of when the document was last modified

trashedstring date-time nullable

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

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

parentinteger nullable

ID of the parent folder

userCollaboratorIdsinteger[] required

List of IDs of users that are collaborators on the document

teamCollaboratorIdsstring[] required

List of prefixed IDs of teams that are collaborators on the document

Example response

[
  {
    "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",
    "title": "document title",
    "adminViewUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/adminView",
    "created": "2019-04-22T13:47:23Z",
    "owner": {
      "ownerType": "user",
      "id": "123456"
    },
    "lastModified": "2020-06-26T16:29:37Z",
    "customTags": [
      "in progress"
    ],
    "product": "lucidchart",
    "status": "Complete",
    "parent": 123456788,
    "trashed": null,
    "userCollaboratorIds": [
      206418105,
      206418104,
      206418103
    ],
    "teamCollaboratorIds": [
      "team_111000660",
      "team_111000661",
      "team_111000659"
    ]
  }
]

Changes