Folders

List Root Folder Contents

Retrieves basic information about the contents of the root folder. Results are paginated.

get/v1/folders/root/contents

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/folders/root/contents
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: folder:readonly)

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.

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

The Lucid Suite product that a document was created in.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.