Skip to main content

Lucid for Developers

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

  • 156 Topics
  • 555 Replies
156 Topics
R
raphael.abdias
asked in Lucid for Developers
Get List of Users - Pagination & License Information

Hi there! I’m trying to get the list of users from the API. So far i was able to get 200 users which i understand is the limit per page. With that said, i’m having a hard time trying to figure out how to move to the next page, the documentation is not clear on what should be done exactly to move to the next pageWhen i fetch the first time i get a Link Header, something like thishttps://api.lucid.co/users?pageSize=20&pageToken=eyJvIjoiMSIsImUiOjE2Mjg2OTc3OTF9>; rel="next"this is the link header of the current page, but how should i move to the next one? i mean, how to i actually use the “next” provided.Link to the documentation:https://lucid.readme.io/reference/reference-rest#paginationAlso, second question, is this Endpoint to List Users able to provide Licenses allocated to users?Thanks in advance,Rapha

3
jkrueger
10 hours ago
S
Sravani.Gundreddy
asked in Lucid for Developers
How to use Lucid Rest APi's

I set up new application with client id and client secret in lucid developer portal. When i tried to use client id and client secret in rest api’s i am getting 404 error. This is the first time i am setting up so i am not sure if i missed any. 

3
jkrueger
7 hours ago
B
Ben Tesch
asked in Lucid for Developers
Sharing custom shape library within company

I recently created a custom shapes library using the external API and would like to share it internally with my coworkers.  Based on https://lucid.readme.io/docs/publishing, it looks like “Private Publishing” is the way to go.There are a couple of snags:I am not an administrator on this account A marketplace listing is required, which in turn asks for URLs for a privacy policy and terms of service.  This shapes library has neither, and I don’t think I have access to hosting for this purpose.  (perhaps I could use https://example.com/ ?)Suppose I create the marketplace listing and reach out to an account administrator and they are willing to help publish this shapes library.  It looks like I would have to add them as an application owner for the library under Collaborators → Invite in the developer portal.  All they would have to do at that point is click publish, select the version, and select “publish privately”, right? Are there other ways to share custom shape libraries internally?

4
jkrueger
1 day ago
D
dbennettLucidite
posted in Lucid for Developers
Building on the Lucid Standard Import

The Use CaseAs a solutions engineer at Lucid I have the chance to work with a number of different customers and hear about so many different use cases for Lucid. One thing that has come up more and more often is importing BPMN files into Lucid as an editable diagram. Now while Lucid provides a few different document import APIs for other solutions including virtual whiteboards and Visio files Lucid hasn’t had a good solution for BPMN files. The SolutionLucid’s Standard Import allows for a JSON import to create Lucidchart diagrams in a pretty seamless way. Through the use of a conversion script we can import BPMN XML documents and create the Lucidchart documents via API.LimitationsThis conversion only supports the most commonly used BPMN shapes including the following:Parse start, intermediate throw, intermediate catch, boundary, and end events Recursively parse tasks (send, receive, user, manual, business, service, script), subProcesses, adHocSubProcesses, transactions, and callActivit

0
D
15 days ago
Michel L
Michel L
asked in Lucid for Developers
How to get the folders under "Home" using Rest API

Using REST API https://api.lucid.co/folders/searchWe can get a list of folders. But only the folder of the user are returned (folder and shared folder). We cannot have Teams Folders. More over, we cannot make the distinction between “Shared with me” folders and the folders of the user.Am I wrong ?I have try to add "Lucid-Request-As" admin" in the header as indicated in the doc but then I got a 403 Error?My scope is nevertheless “folder:readonly folder:admin.readonly”Any help ?It could be great to get the home root folders “Documents” “Shared with me” and to have the sub folders” “Team folders” and “My documents” of “Documents” folder.Best regards.

4
Emma D
4 hours ago
Daniel H
Daniel H
asked in Lucid for Developers
Extension packages work in mobile app?

Hello,if you build a custom package app in Lucidchart, will that be available for users in the mobile app of Lucidchart?  Thanks, Dan

1
Humas1985
Lucid Legend Level 4
15 days ago
D
darrinps
asked in Lucid for Developers
Sample code to access a directory of charts and generate .csv representations

I know that I can generate a .csv file for a given chart via the File->Export->CSV of shape data, but I’d like to do this programmatically a directory at a time.Is there any sample code of how that can be done, please?

1
Richard U
19 days ago
K
KGV
asked in Lucid for Developers
Lucidcharts custom shape identification in lucid plugins

Hello,I created a custom shape library with few of custom shapes with this method, and with Extension APIs I only can get some common predefined properties of the used shapes, none of them reflects the custom shape information like Library name or shape type! Is there a way to pragmatically identify/read the shape type a library inside a LucidChart plugin? Note:As a workaround for now, I used the textarea “name” property where I store some info of the shape itself so that I retrieve and identify the used shape, but it doesn’t look ideal for me!{ "properties": [], "style": { "fill": { "type": 'color', "color": '#D7FAF55F', }, "stroke": { "color": '#808080', "width": 6 }, "rounding": 50, }, "geometry": [ { "type": "rect" }, ], "textarea" : { "name" : "customeLibrary000customShapeType", "text" : "Specific Module", "editable": true, "style": { "color": "#0a0a0a" }, },} 

8
K
1 day ago
Michel L
Michel L
asked in Lucid for Developers
Lucidspark Rest API

Did API exist on LucidSpark for developers ?

3
Humas1985
Lucid Legend Level 4
22 days ago
B
Ben Tesch
asked in Lucid for Developers
Adding new custom shapes freezes document

I have a fairly complex diagram that uses a lot of shapes from a large custom shape library.I’m running into a problem where the document freezes (the zoom percentage changes but the view does not change, and I can’t pan) if I try to add a shape from this custom shape library that is not already present in the document.That is, if shape A is already in the document, I can add it no problem.  If shape B is not already in the document, adding shape B causes the document to freeze.  Sometimes the offending shape disappears right away, sometimes it doesn’t.  The shape is always gone after I reopen the document.Creating a copy of the document doesn’t fix the problem.Can you help? Please let me know how to point you to these files.  The document is a confidential work document so I cannot publicly link it.  This form doesn’t let me attach the shape library.

14
B
5 days ago
P
PromitaDan
asked in Lucid for Developers
Issue with Data Connector in Lucid Extension - Need Help

  DescriptionI'm having trouble getting a data connector to work in my Lucid extension. Specifically, when I trigger a data connector action, I'm encountering issues that prevent the action from executing properly. I've set up the data connector in my `manifest.json` file and written the corresponding code, but it's not working as expected.Manifest.json Setup{  "dataConnectors": [    {      "name": "quodsi_data_connector",      "oauthProviderName": "",      "callbackBaseUrl": "http://localhost:5000/api",      "dataActions": {        "Simulate": "Scenario/simulate"      }    }  ]}Data Connector Index.ts import { DataConnector, DataConnectorClient } from 'lucid-extension-sdk';import { simulateAction } from './actions/simulateaction';export const makeDataConnector = (client: DataConnectorClient) =>    new DataConnector(client)        .defineAsynchronousAction("Simulate", simulateAction);SimulateAction.tsimport { DataConnectorAsynchronousAction } from 'lucid-extension-sdk';import axios

4
T
14 days ago
S
son.pham
asked in Lucid for Developers
Create OAuth2 App without Listing to Marketplace

Hi,We need to download all documents as images once per month, the code is running on a Virtual Machine with a schedule job that will connect to Lucid App REST API and calling some endpoints I try to create Client App in Admin Developer portal, the Test Redirect URL does not work when I enter in the browser, I got “Page not Found”. I guess I have not listed my app to the market as required, but in this case. Why do we need that step? My app does not have any logos, images, or url. What should I fill in the form? Thanks 

7
Michael B
16 days ago
N
nathanlewan
asked in Lucid for Developers
create new user with SCIM including shared group memberships

hello,I was attempting to use the SCIM to create users with one call to the SCIM, but have had no luck with passing shared group memberships as an attribute on the user creation call. The user gets created, but the shared groups I passed, are ignored.  Since the SCIM docs don’t show groups as part of the options for user creation, is it safe to assume it’s not possible, or am I doing something wrong?thanks!

2
N
28 days ago
P
PromitaDan
asked in Lucid for Developers
Ability to add custom shapes to "Change Shape" right panel

Is there a way Load up the “Flowchart” template. Select any shape in the template.  In the right context panel, there is a label “Change Shape” where the user can pick a different shape.Is it possible to add additional shapes in this drop down box?  I would love to be able to add a few of my shapes from my custom extension package. Possible?

4
Richard U
29 days ago
B
Ben Tesch
asked in Lucid for Developers
Custom Shape Link Points

I’m trying to create a custom shape that only has two link points, similar to “DC Voltage Source 1” in the “Circuit Diagrams” → “Power Sources” library.  Link points are circled in green. When I try to create a custom shape, I can add link points just fine.  There are two below in my custom shape in the corners (because I am debugging right now), and they are circled in green.  These appear when I am drawing a line.  The trouble is, there are four points that show up by default, and I can’t figure out how to get rid of them.  They behave differently from the link points above and show up whenever I hover the cursor over my custom shape.What are these four default points, and how can I modify the custom shape definition to remove them?  The “DC Voltage Source 1” shape from Lucid’s library doesn’t have them, so it must be possible.  I just can’t figure it out from the documentation. Here’s “library.manifest” for my custom shape:{ "name": "Electrical Symbols", "shapes": [ {

4
Connor B
1 month ago
Jordan B
Jordan BLucid product team
posted in Lucid for Developers
Enterprise Shield APIs

Hello, Lucid Developers Community! We're excited to announce several new APIs as part of the launch of our Enterprise Shield add-on, which brings an enhanced layer of fortified security and control to an account on Lucid’s already highly secure platform.Enterprise Shield introduces powerful APIs tailored to enhance security and compliance within your organization. Currently, Enterprise Shield offers:Document management API: Enables streamlined management of documents and folders within the Lucid ecosystem. Legal hold API: Empowers organizations to effectively manage and preserve documents during litigation. Audit logs API: Captures a diverse array of security and compliance events. To get started with Enterprise Shield APIs, check out our detailed guide in the Developer Documentation. For further inquiries or support regarding Enterprise Shield APIs, please reach out to your account team or post a question in the thread below! Cheers! Jordan, Enterprise Product Manager 

0
Jordan B
1 month ago
P
PromitaDan
asked in Lucid for Developers
Document or Page custom data

I have created a LucidChart package that has custom shapes, data connectors and extension editor.  My custom package adds custom data fields to shapes and that is working great.I need similar capability to add custom data to either the document or a page.  My gut says the feature exists and is probably staring at me in the documentation but I honestly am not seeing it.  On a similar note, if the feature exists, how can I, as a standard user in LucidChart, see or manage the custom data of the document and/or page in the UI?Thanks, Dan

4
A
1 month ago
P
PromitaDan
asked in Lucid for Developers
programmatic way of knowing when the shape selection has changed?

Hello,Is there a programmatic way of knowing when the shape selection has changed?I have a right context in my package and custom shapes.  My custom shapes have a  custom data property on it called q_type.  What I want to do is:Click open the right click context panel.  Keep it open. Select Shape1 which has a custom data property “q_type” value of “foo”.  Show the “foo” form in the right click panel.   User now selects Shape2 which has a custom data property “q_type” value of “bar”.  Show the “bar” form.In my extension app, can I register a method to a on selection changed event?Thanks, Dan

4
Michael B
1 month ago
P
PromitaDan
asked in Lucid for Developers
Iframe communication inconsistently working

Team,I am developing a LucidChart extension package.  It has editor extension, shape library, etc. Within my editor extension, I will be using Modal and Panel that gets its content from React.  I need the Lucid parent Modal or Panel to send data to child React app where the user will make some edits.  After editing, the child react form will send back to the parent Modal or Panel.I have followed the documentation but the end result is very inconsistent.  Sometimes the react app gets the message and sometimes it does not.  Maybe I have implemented it wrong.The package code, including the React app can be found in this public Repo:https://github.com/GreenShoesLLC/lucidchart_package_testHere are the details.When the user clicks on a shape, the test package adds a menu that when clicked, shows the following Lucid Modal. import { EditorClient, Modal, Viewport} from 'lucid-extension-sdk';export class EditorModal extends Modal { constructor(client: EditorClient) { super(client

3
Michael B
1 month ago
S
samarthakhare
asked in Lucid for Developers
Urgent Help Needed- Regarding Non-lucid Import

Hii Can I import a UML diagram created via some other tool (say PlantUml) in a lucid document through its api.If so then what will be its import format and will it be editable ??  

1
Humas1985
Lucid Legend Level 4
1 month ago
Michel L
Michel L
asked in Lucid for Developers
Suspicion of Bug in Rest Api Get Document content

It seems that there is a limit of document size when trying to retrieve the content of a document with the endpoint https://api.lucid.co/documents/{YourDocumentId}/contentsThe limit is about 40000 lines in the json result.If this limit is exceeded the endpoint returns an error code of 400  for bad request which is not a good response as the endpoint is successfull when the same document contains less elements (block, lines, groups, ...)Any explanation?Best regards.

3
Michael B
1 month ago
J
jhallmark
asked in Lucid for Developers
Use API to set status

Is there a way to use the API to set the Status on a document?

2
Michael B
1 month ago
J
jhallmark
asked in Lucid for Developers
API Document Search options

Is there a way to search for documents, using the API, using tags, status and/or classification as a search parameter?

1
Michael B
1 month ago
Jonathan M102
Jonathan M102
asked in Lucid for Developers
BUG: COUNTIF(source, x=> GET(x, this."Field") = this."Value") fails when "FIELD" is the output of a formula

I've created a shape object that has three fields. One field is named "Field" this is the column name of a data source where I want to count values in the rows that match a specific value. The next field is named "Value" this is the text value I want to match and count in the column of the data source. Finally I have a third field named "Count" that has a formula that counts the rows in the data source where the name matches. This solution has worked great for the last week or so. I can duplicate the shape and change the "Field" value or the "Value" value and I get the counts I want, very reusable. I wanted to evolve this by putting my shape in a container and having the "Field" value be a formula that pulled the value of the container name/label. When I did this it seemed to work the new "Dynamic Field" pulled the value I wanted that matched the static "Field" value. But when I updated the formula to use the "Dynamic Field" value my count ended up being 0.  Screen shot of the "Count"

5
Richard U
1 month ago
P
PromitaDan
asked in Lucid for Developers
Connectors in Shape Library?

I have a need to provide a Connector with custom data fields.  My intent was to add a “connector” shape to a custom shape library.  After playing with the custom shape library, I do not feel this is possible.  Is it?  assuming it is not possible, any suggestions?  Perhaps my extension package would handle whenever some creates a new connector, it detects it and adds the custom field?Thanks, Dan

5
J
1 month ago
Lucid Software Inc. Supplemental Community Terms