LUlucid
Folders

List Folder Contents

Changed on

Retrieves basic information about the contents of a given folder. Results are paginated. With only a document.app.folder scope, the folder must be the app project folder or inside it, and root is not available.

get/v1/folders/{id}/contents

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
      Scopesfolder:readonly, lucidchart.document.app.folder, lucidspark.document.app.folder, lucidscale.document.app.folder
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

number required
OR
'root' required

ID of the folder or root to retrieve contents of the authenticated user's root directory ("My Documents").

Query parameters

filter'type=folder'

Restricts the listing to one kind of entry. The only supported filter is "type=folder", which returns only folders. If no filter is provided, both folders and documents are returned. The filter is kept in the next page link.

Response

OK with an array of Folder Content Resources containing information about the contents of the requested folder.

type'folder' | 'document' required
  • folder - Type denoting that the Folder Content Resource is a folder and will have a Number id field and no product field.
  • document - Type denoting that the Folder Content Resource is a document and will have a UUID id field and will contain a product field.
namestring required

Name of the folder or document

isShortcutboolean required

A boolean value indicating whether or not the folder or document is a shortcut.

accountIdinteger nullable required

ID of the Lucid account that owns the Folder Content Resource.

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

The Lucid Suite product that a document was created in.

Example response

[
  {
    "type": "document",
    "name": "Folder Name",
    "accountId": 1234,
    "product": "lucidchart"
  }
]

Changes

  • 9c2c917ec59cRevision changes
    • info

      the security scope lucidchart.document.app.folder was added to the endpoint's security scheme OAuth2

    • info

      the security scope lucidscale.document.app.folder was added to the endpoint's security scheme OAuth2

    • info

      the security scope lucidspark.document.app.folder was added to the endpoint's security scheme OAuth2

    • info

      added the new optional query request parameter filter

    • info

      added the required property / to the response with the status