Action

Description

Required scopes

Get Account

Retrieve basic information about the authenticated Lucid account, including the account ID and name.

List Document Collaborators

List all collaborators (users) on a specific document.

Get Document User Collaborator

Retrieve a specific user's access role on a document.

Set Document User Collaborator

Grant or update a user's access role on a document.

Remove Document User Collaborator

Revoke a user's access to a document.

Get Document Team Collaborator

Retrieve a specific team's access role on a document.

Set Document Team Collaborator

Grant or update a team's access role on a document.

Remove Document Team Collaborator

Revoke a team's access to a document.

List Folder Collaborators

List all user collaborators on a specific folder.

Get Folder User Collaborator

Retrieve a specific user's access role on a folder.

Set Folder User Collaborator

Grant or update a user's access role on a folder.

Remove Folder User Collaborator

Revoke a user's access to a folder.

Get Folder Team Collaborator

Retrieve a specific team's access role on a folder.

Set Folder Team Collaborator

Grant or update a team's access role on a folder.

Remove Folder Team Collaborator

Revoke a team's access to a folder.

List Document Threads

List all comment threads on a Lucid document, each with its ID, creation time, and open/closed status.

List Thread Comments

List all comments within a specific comment thread on a Lucid document.

Post Thread Comment

Post a new comment to an existing comment thread on a Lucid document.

Create Document

Create a new blank Lucidchart or Lucidspark document with a title, optionally inside a specific folder.

Copy Document

Create a copy of an existing Lucid document with a new title, optionally inside a specific folder.

Get Document

Retrieve metadata about a specific Lucid document, including its title, product, owner, and edit history.

Get Document Contents

Retrieve the structured contents (pages, shapes, and data) of a specific Lucid document.

Update Document

Update properties of an existing Lucid document, such as its title, parent folder, classification, or custom tags.

Trash Document

Move a Lucid document to the trash. This is a soft-delete — the document is recoverable, not permanently removed.

Search Documents

Search the requesting user's documents by keywords, product, owner, status, and creation or modification dates.

Export Document (Async)

Start an asynchronous export of one or more pages of a Lucid document to an image or PDF format.

Get Document Export Status

Check the status of an asynchronous document export job and retrieve the download URL when complete.

Create Folder

Create a new folder, optionally nested inside an existing parent folder.

Get Folder

Retrieve information about a specific folder.

Update Folder

Update a folder's name or move it to a different parent folder.

Trash Folder

Move a folder to the trash. This is a soft-delete — the folder is recoverable via restore\_folder, not permanently remove...

Restore Folder

Restore a previously trashed folder.

List Folder Contents

List the documents and subfolders contained in a specific folder.

Search Folders

List folders the authenticated user has at least read-only access to, sorted by creation date.

List Root Contents

List the documents and folders at the root of the authenticated user's Lucid workspace.

Create Mermaid Diagram

Create a diagram in a Lucidchart or Lucidspark document from Mermaid markup.

List Mermaid Diagrams

List the Mermaid diagrams in a Lucidchart or Lucidspark document.

Get Mermaid Diagram

Retrieve a specific Mermaid diagram in a document, including its markup.

Update Mermaid Diagram

Replace the markup of an existing Mermaid diagram in a document.

Create Document Share Link

Create a share link that grants access to a document at a specified role.

Get Document Share Link

Retrieve information about a share link on a document.

Update Document Share Link

Update the settings of an existing share link on a document.

Delete Document Share Link

Delete a share link from a document.

Create Folder Share Link

Create a share link that grants access to a folder at a specified role.

Get Folder Share Link

Retrieve information about a share link on a folder.

Update Folder Share Link

Update the settings of an existing share link on a folder.

Delete Folder Share Link

Delete a share link from a folder.

Create Team

Create a new team on the account.

List Teams

List the teams the authenticated user has access to.

Get Team

Retrieve information about a specific team.

Update Team

Update a team's properties, such as its name.

Archive Team

Archive a team, removing it from active use while preserving its data.

Restore Team

Restore a previously archived team.

List Team Users

List the members of a specific team.

Add Team Users

Add one or more users to a team.

Remove Team Users

Remove one or more users from a team.

Get Profile

Retrieve the profile of the authenticated Lucid user, including name, username, and email.

Get User

Retrieve information about a specific user on the account by their user ID.

List Users

List all users on the authenticated Lucid account.

Search Users

Find a user on the account by their email address.

Create User

Create a new user on the account (Enterprise accounts only).