Lucid

Lucid REST API for Lucidchart, Lucidspark and Lucidscale: search and read documents and their contents, folders, collaborators, comment threads and users; copy templates, organise folders and comment.

Keep diagrams and whiteboards in step with projects: create documents from templates, file them, track changes and pull comments into work tracking.

Build a flow with Lucid Provider API documentation

Source actions

Destination actions

Data types

Validation status

Implemented · fixture tested.

Implementation is checked against provider-shaped fixtures for every action, authentication failures, rate limits, pagination and duplicate safety. Provider sandbox and authorised account validation are recorded separately when credential-backed runs are completed.

What you can map

account users

Get account user
Source
One user on the authorised account.
account_users.get
List account users
Source
Users on the authorised account (account token or admin scope).
account_users.list
Find users by email
Source
Users on the account whose email exactly matches (sent in the request body).
account_users.search

comment threads

List comment threads
Source
Comment threads on a document with status.
comment_threads.list

document collaborators

List document collaborators
Source
Users with access to a document and their roles.
document_collaborators.list

document pages

List document pages
Source
Pages of a Lucidchart or Lucidspark document with shape, line and group counts and their text.
document_pages.list

documents

Create document from template
Destination
Not retried automatically
Approval before production
Copy an existing document or template into a new document with a title, optionally in a folder.
documents.create
Get document
Source
Document metadata: title, product, links, version, pages, owner and attributes.
documents.get
List documents
Source
Incremental
Documents the user can read, oldest created first, with modified-time and product filters.
documents.list
Search documents
Source
Documents matching keywords, ranked by relevance.
documents.search
Update document
Destination
Provider duplicate protection
Approval before production
Rename a document, move it to another folder or repository, or set its tags.
documents.update

folder contents

List folder contents
Source
Documents and sub-folders in a folder, or in the user's root folder.
folder_contents.list

folders

Create folder
Destination
Not retried automatically
Approval before production
Create a folder, optionally inside another folder.
folders.create
Get folder
Source
Folder or team folder name, parent, repository and attributes.
folders.get
Update folder
Destination
Provider duplicate protection
Approval before production
Rename a folder or move it under another folder.
folders.update

thread comments

Post thread comment
Destination
Not retried automatically
Approval before production
Add a comment to an existing comment thread on a document.
thread_comments.create
List thread comments
Source
Comments in a document's comment thread, with authors and assignees.
thread_comments.list

users

Get authorised user
Source
The authorised user's profile: name, username, email and account.
users.get

Authentication

Lucid OAuth 2.0 client (user token with offline access; refresh tokens rotate)

Plans and access

Any Lucid account can create an OAuth 2.0 client in the Lucid developer portal. User and account management reads need an account (admin) token. User tokens act as the authorising user and see only documents and folders shared with them. Account-wide document search needs admin scopes.

Test environment

Lucid has no sandbox; authorise the OAuth client with a test Lucid account.

Rate limits

15 requests per second per user token and 50 per account token; document and folder search are limited to 300 requests per 5 seconds per account. HTTP 429 includes Retry-After in seconds.

Pagination

Paginated endpoints take pageSize (up to 200) and return a Link rel="next" URL with an opaque pageToken; Nexra follows it.

Provider events

Lucid does not offer webhooks on the REST API. Nexra event triggers are not yet available; flows run on demand or on a schedule.

Before you build a flow

No deletes or trashing: Nexra never trashes documents or folders, removes collaborators or deletes share links.
No sharing changes: Nexra does not create, update or accept share links, or add or change collaborators, so content is never made public.
Document creation copies an existing document or template (POST /documents/copy). Creating from Standard Import JSON or an external file needs a file upload and is an engine gap, as is image export of documents.
User list and lookup need an account token or admin scopes (account.user:readonly); a user token returns HTTP 403.
Folder search is not offered: Lucid documents its Lucid-Request-As header as required, which conflicts with the non-admin description, so the request contract is unverified.
Lucid documents the token endpoint with a JSON body; Nexra sends the standard form-encoded refresh request, which Lucid accepts (it parses form fields), but this content type is not documented.
Document contents are summarised per page (shape, line and group counts and text); the full shape model is not mapped.
Comment threads and comments are not paginated by Lucid.

Developer reference

Create the Lucid Software Inc. credentials described above with the narrowest permissions your flows need.
In Nexra, open Connect, then Connections, then New connection, choose Lucid, enter its settings and credentials, and tick only the write actions you need. Connection guide
Test the connection, then use its actions as flow sources and destinations. Flow guide

Lucid Software Inc. docsAPI reference Lucid Software Inc. docsAuthentication Lucid Software Inc. docsRate limits

Machine-readable detail: GET /api/public/connect/connectors/lucid and the Connections API.