Search Account Documents

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

📘
This API is exclusive to Enterprise Shield accounts
Only the account owner or a document admin can grant access to this API.

Returns a list of all documents belonging to the requesting user’s account, sorted by created date.

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

DocumentAdmin

OAuth 2.0 User Token Scopes:

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

Body Params

userIds

array of numbers

List of userIds to include in the search. If no ids are provided, it will search across the entire account.

userIds

ownedByUsers

boolean

Truthy if search results should only include documents owned by users specified by userIds. Ignored if no userIds are provided.

documentIds

array of uuids

List of documentIds to filter by.

documentIds

classificationIds

array of uuids

List of classificationIds to filter by.

classificationIds

statusIds

array of numbers

List of statusIds to filter by.

statusIds

createdStartTime

date-time

Start of range to filter documents by created time.

createdEndTime

date-time

End of range to filter documents by created time.

lastModifiedStartTime

date-time

Start of range to filter documents by last modified time.

lastModifiedEndTime

date-time

End of range to filter documents by last modified time.

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

keywords

string

Keyword(s) to search against document content and titles. When provided, results will be sorted by relevance to keyword search.

documentLocation

string

Specify to search for documents owned by team folders, owned by users, or deleted

externalAccess

string

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

Headers

Lucid-Api-Version

string

required

Defaults to 1

The API version used in the request.

Lucid-Request-As

string

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.

Responses

400

Bad Request if incorrect format

403

Forbidden if "product" query parameter is used and the token’s scopes do not contain the matching readonly scope for each product, or account does not have access to the API

429

Too Many Requests if account makes more than 300 requests in 5 seconds

Language


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


xxxxxxxxxx
18
 
1
{
2
  "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",
3
  "title": "document title",
4
  "adminViewUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/adminView",
5
  "created": "2019-04-22T13:47:23Z",
6
  "owner": {
7
    "ownerType": "user",
8
    "id": "123456"
9
  },
10
  "lastModified": "2020-06-26T16:29:37Z",
11
  "customTags": [
12
    "in progress"
13
  ],
14
  "product": "lucidchart",
15
  "status": "Complete",
16
  "parent": 123456788,
17
  "trashed": null
18
}

📘This API is exclusive to Enterprise Shield accounts

📘

📘

Valid Authentication Methods

API Key Grants:

OAuth 2.0 User Token Scopes:

200With paginated list of Account Documents

📘
This API is exclusive to Enterprise Shield accounts