Skip to main content
hamburger menu
+ Create a topic

Lucid for Developers

Learn from and collaborate with other developers. Find answers to your most technical questions and get support with Lucid's APIs.

  • 299 Topics
  • 1,089 Replies
299 Topics
J
jdockett3
asked in Lucid for Developers
License management under LucidSuite

Hello, We were using the SCIM api with a connector app to Grouper, but since the update to LucidSuite, that no longer works.The developer docs still reference doing licenses like this:"productLicenses": {    "Lucidchart": True,    "Lucidspark": false,    "LucidscaleCreator": false,    "LucidscaleExplorer": false} Do you have the updated schema available so that we can restore license functionality?

1031
Adam Y
U
ufarr
asked in Lucid for Developers
Getting multiple tabs diagram via API

Hello Team, I am using API to export document. However, it exports only first tab of the document. Could you point me to resources / end-points that I could use to export all tabs within a diagram?

1537
U
J
jacki
asked in Lucid for Developers
Converting Excel Employees to Salesforce Contacts

I would like to know if there is a way to convert employee cards from auto generate Excel org charts into contact cards for Salesforce. The current format of the org chart from Excel lists all contacts as employees, but is there a function to convert them to contacts? 

371
Ian Baenziger
A
AlexanderZ
asked in Lucid for Developers
Error (Status Code) 500 when requesting document content over API

Hello everyone,I have the following problem, I have created a script to get all data about the shapes of each page from a Lucidchart document with the Lucid API. The Lucid document now has over 160 pages. The script worked as long as the Lucidchart document had fewer pages, now I get the status code 500 when requesting the contents (see the snippet of the code for the request)....headers <- httr::add_headers( 'Authorization' = paste('Bearer', token$credentials$access_token), 'Lucid-Api-Version' = '1')....response_document_content <- httr::GET(paste0("https://api.lucid.co/documents/", document_id, "/contents"), headers)#test responseif (response_document_content$status_code == 200) { content_document_content <- httr::content(response_document_content, type = "application/json")} else { cat("Request failed with status:", response_document_content$status_code, "\n") cat(content(response_document_content, "text"), "\n")}To reduce the load of the request, I tried to reduce it

1111
Richard Udell
U
ufarr
asked in Lucid for Developers
Getting error while embeding document

Getting following error while attempting to embed a document in html  

461
Adam Y
B
blibanos
asked in Lucid for Developers
AccessForbidden

Hello, I am trying to create a script that would export all files in the Lucid platform as an image file, however I am getting the following error message when trying to call the api below. The interesting part is though, I don’t get this error message if I have opened the file in a browser prior to using the api.  Is this a bug or is it something I am not doing. api:https://api.lucid.co/documents/03682f3d-7947-41d5-bd3c-1ea6e66f68b5response:{ "code": "accessForbidden", "message": "Access to this resource is forbidden", "requestId": "42f57773fbf39c50"}Thank You, Bereket Redhat Inc. 

23110
B
Sylvia X
Sylvia XLucid support team
posted in Lucid for Developers
Lucid Standard Import (a.k.a. JSON Import) API FAQ

Hi Lucid Developers! 👋Since the launch of our JSON Import functionality, we've seen an array of creative and efficient uses by our customers. In this post, we'll address some of the most frequently asked questions about the JSON Import feature. Additionally, we’d like to announce expanded functionality based on your valuable feedback: support for adding notes to shapes via the API! 🌟 Adding notes to shapes 📄You can now add notes to shapes, groups and layers by including a note field in your shape properties. For more information on how to do this, feel free to check out our documentation here!  JSON Import API FAQs 🙋 Q: Is the JSON import asynchronous? How will I know when the import is complete?No, it is actually synchronous. When the request is returned, the document is complete. Q: Is z-order for an entity based on array position? Last-on-top or first-on-top? (Does this mean lines are already "on top" of shapes, since it is a separate array?)In Lucid's JSON structure, z-order re

8400
Sylvia X
ben.bahrman@headintheclouddev.
ben.bahrman@headintheclouddev.
asked in Lucid for Developers
Error with Embed Rest API

I’m getting an error while trying to embed a Viewer iFrame using the REST API. “Our servers experienced an error. We apologize for the inconvenience. I send a POST to https://api.lucid.co/embeds/token with no embedId, just the origin in the body and the bearer token in the header per the documentation here: https://developer.lucid.co/rest-api/v1/#generate-embed-session-token60 I get back a Session Token in the body of the response and then set this as my iFrame source:https://lucid.app/embeds?token=:token where :token is replaced with the response from the POST and get the below error. This was working previously but stopped working at some point, I think in December. I believe it is also not working when there is an embedId but haven’t had a chance to retest that.  

1487
ben.bahrman@headintheclouddev.
ben.bahrman@headintheclouddev.
ben.bahrman@headintheclouddev.
asked in Lucid for Developers
API: Create User With license asigned

I’m trying to create a user via the REST Api, I can successfully create them but they don’t get created with a license. Is there a way to create a user via the REST API with a standard user license assigned?

1232
ben.bahrman@headintheclouddev.
Nick D101
Nick D101
asked in Lucid for Developers
Error using Object syntax from documentation

I am trying to develop functionality for a custom Extension and I would like to reference a value from a JSON object stored in a Field. The documentation has formulas (such as GET(obj, val)) that I am trying to use. However, they are not working and I am running into issues.I then tried to figure out the intended format of objects by using the examples provided in the documentation. However, these do not work and I am needing help.Using this page: https://developer.lucid.co/formulas/#get, I am trying to get the GET formula of the Object class working. There is a Field called “Object” with values “{ "A": 1, "B": 2, "C": 3, "D": 4, "E": 5, }”. Then, values can be retrieved from that object using =GET(@Object, “A”). I tried to simulate this on my own document but ran into issues. Can someone help me understand the format objects can be stored in? Specifically, can I store an object in JSON format in a field and use the GET formula to get value from it?Link to test document: https://lucid.

1013
J
A
arajN2
asked in Lucid for Developers
Create/Update Document User Collaborator issue

What are the ideal scopes needed for this User token when trying to access a lucidchart document? Having tried most of the scopes provided in the documentation, I have not been able to get anything other than a 403 error. Verified the error code from the website as well, created a lucidchart test doc with a valid id to work with. Any ideas or information on how to approach this would be helpful.

551
Abigail M
Luke I
Luke I
asked in Lucid for Developers
API endpoint for Publishing a View only URL for a non account holder

Is there a way to share a URL like you can in the Share>publish menu via the developer API? Thanks  

633
Richard Udell
Ashley C
Ashley CLucid support team
posted in Lucid for Developers
Get support for a partner-built integration 🔎

With Lucid’s REST and extension APIs, developers can get creative and build the integrations they want. So many excellent integrations have already been built—check them out and install them from the Integrations Marketplace! When you have questions or need support with a partner-built integration, we recommend reaching out to the partner’s support team for the best experience and quickest resolution. If you’re interested in building an integration of your own, you can learn all about how to access Developer tools in Lucid in our help center article. We’re looking forward to seeing what you create!

710
Ashley C
Richard Udell
Richard UdellLucid support team
posted in Lucid for Developers
Your new community platform: a central hub for all Lucid developer resources

Welcome to our new community platform!You might have noticed some changes around here – that's because we've upgraded to a new platform for the entire Lucid Community, bringing new features and opportunities for all our members, including the Lucid for Developers community space. What’s new?Now you can earn builder badges, more dynamically engage with forum discussions, participate in Groups, and even send private messages to other Community members, and more easily format code in your posts and comments. As we make this exciting transition, it's the perfect opportunity to revisit the wealth of resources available for interacting with Lucid's APIs and building extensions. Key resources for interacting with Lucid's APIs and building extensions: Getting started with our public APIs: Visit our Development guide Review documentation for our REST API, Extension API, SCIM API, Custom Shapes and Formulas  Visit our Help Center article on Developer Tools Go to your Developer Portal and crea

2800
Richard Udell
Deepak C
Deepak C
posted in Lucid for Developers
Lucid Integration with JS based website

Hi all Is it possible to integrated Lucid in websites build with FE tech like Angular/React where user can see and utilize all the functionalities like create floorplan etc. here users of this system won't need to have their own Lucid account system will use common account with separate document for each user.  

870
Richard Udell
Christopher K101
Christopher K101
posted in Lucid for Developers
Error 500 when trying to upload new custom shape package

Hello I'm working on a custom shape library. I got a new package uploaded but there was a problem with it. So I fixed it (I think) and tried to upload a new bundle and I got an error:Can't seem to figure out what the issue is.

340
Richard Udell
Vyshnavy S
Vyshnavy S
posted in Lucid for Developers
Export Lucidchart in csv format directly using an external api to third party service

I am interested in integrating Lucidchart with our third-party application to access Lucidchart documents. However Lucid REST API integration lacks shape library details necessary for converting content to BPMN format which is one of our preferred formats. I am exploring the possibility of directly exporting Lucidchart documents in CSV format via an external API or a custom API service that connects to our third-party application. This would greatly enhance our workflow and allow for seamless data exchange between systems. I kindly request assistance and guidance on achieving this integration and CSV export functionality. Your expertise and support in this matter would be greatly appreciated.  

1860
Richard Udell
Krishna K
Krishna K
posted in Lucid for Developers
invalid_scope error when during oAuth setup

Hello Any idea on what this invalid_scope error would be? Trying to setup oauth connectivity.   https%3A%2F%2Fdeveloper.lucid.co%2Fapi%2F%23general-oauth2-errors&error_description=Invalid+scopes%3A+&state=-529097523

1120
Richard Udell
Tuto O
Tuto O
asked in Lucid for Developers
Angular Application Problem

Hello currently I am developing an integration using Angular to create a panel for dragging blocks. I am trying to follow the Angular guide provided by Lucid here:https://developer.lucid.co/guides/#angular However I am encountering a problem. My panel appears and I can see my blocks but when I try to drag a block it doesn't get placed on the canvas. I'm not sure how to implement the part described in "Step 6: Write your Angular app." I'm unsure if this component is necessary to refresh the web page when I place a block. Please help me with this issue.     I didn't implement this code: import {Injectable} from '@angular/core';@Injectable() export class DataFromExtension {public ids: string[] = [];constructor() {//Listen for lists of selected item IDswindow.addEventListener('message' (event) =>{ if (event.data['ids']) { this.ids = event.data['ids']; } });//Once ready to receive those messages ask the extension to refresh dataparent.postMessage('refresh' '*'); } }

830
Tuto O
Daniel H
Daniel H
asked in Lucid for Developers
Customizing LucidChart UI

I have created custom UIs within MIRO as part of my organization product offerings.  We would like to provide a similar experience to LucidChart.  React would be our preferred web framework and I see documentation on this. LucidChart toolbar has File Edit View Insert set menu items.  Can you extend LucidChart menu?  Add a new menu item perhaps with sub menus? Shapes on the document in LucidChart contain a right click.  Can you add new right-click menu items? The documentation for React UI shows adding a new custom right panel.   I looked but cannot find the other options to add panels or modals.  What are the alternatives? Thanks Dan

460
Richard Udell
Daniel H
Daniel H
posted in Lucid for Developers
End user process for adding custom UI apps?

I read the documentation on how to use React web framework to make custom UIs within LucidChart which can be found here: The documentation does a good job of explaining the development workflow.   Suppose I built a new react custom right panel.  How can I provide this custom right panel to all potential Lucidchart users? What is the process for end users to add custom apps?

130
J
M V
M V
asked in Lucid for Developers
Create document contents via Rest API in Lucidchart

We are trying to create chart using API but we see only GetContents API only. Is there any POST API where we can create chart contents using the API.  

43012
Ian Baenziger
Iconduck
Iconduck
asked in Lucid for Developers
Having trouble with Parent/iframe Message Posting in Lucid

With respect to the Extension API calling `this.sendMessage` is not resulting in the iframe receiving the message. The code is being called from a class that extends `Panel`. The receiving iframe _does_ receive messages from the parent frame but not the ones I'm sending. Here's some of the `extension.ts` code: https://pastebin.com/LnTGjp9C The receiving frame's code is simple: window.addEventListener('message' function(event) {    console.log(arguments);}); Here's a screenshot of the events that _are_ captured (but not the one I'm sending from the parent):  https://s3.us-west-2.amazonaws.com/onassar.prod.02/screenshots/Screenshot%202023-08-28%20at%201.18.44%20PM.jpg

780
Iconduck
john.a.lopez
john.a.lopez
asked in Lucid for Developers
Automating API Calls with Lucidchart Formulas

First note the link to the forum:https://lucidchart.zendesk.com/hc/en-us/community/posts/17739799655316-Embed-Jupyter-Notebook-in-LucidChart-diagram-and-visa-versa?page=1#community_comment_18595071382932 The purpose of this is to drive automations that in turn return some value and thus influence the shape-object metadata and hence the conditional formatting. A use-case may be with a decision/gateway that collected data from previous task-properties via UPSTREAMDEEP. This is sent to the Python code that in turn evaluates the parameters makes a decision and returns that decision to the gatetway. This has numerous applications both in simulations and also in live-service at edge device status reporting. Please advise your thoughts. Thank you

983
Emma D
Richard Udell
Richard UdellLucid support team
posted in Lucid for Developers
Using the Lucid Extension API to fetch the URL response from a shape that "links to a web page"

@john.a.lopez  asked about enhancing the shape Actions > Link to Web feature by building an extension that fetches a response from a linked URL and then uses this response to populate a property value for a Lucidchart shape. That's a great question and I thought I'd move it here to the Lucid for Developers Community space for discussion on how this can be done!Can the URL set in an Action stored in the MapProxy.values and accessible via BlockProxy.allShapeData?A property named 'Link' is returned by block.properties.get('Link')  Does the URL need to be explicitly set as one of the shape's properties?No the user doesn't need to define the URL in the custom shape data. The URL will be stored in the block properties as 'Link'so long as it is assigned to the shape's with shape Actions > Link to Web feature. Finally once you have the URL then you can make a request to it using editorClient.xhr .or editorClient.oauthXhr to recover the response. For detailed documentation please refer to

410
Richard Udell
Lucid Software Inc. Supplemental Community Terms

Get Started

Products

Solutions

Resources

Company

Privacy Legal Cookie privacy choices Cookie policy
© 2025  Lucid Software Inc.