Lucid Chart

the lucid chart connector streamlines diagramming and collaboration workflows by integrating with lucid chart's api, enabling automated actions within the swimlane turbine platform lucid chart is a visual workspace that combines diagramming, data visualization, and collaboration to accelerate understanding and drive innovation the lucid chart connector for swimlane turbine enables users to automate the creation, copying, and management of diagrams and folders, enhancing team collaboration and operational efficiency with this integration, users can seamlessly import, export, and search for lucid chart documents, as well as manage user profiles and audit logs, all within the swimlane turbine platform this connector empowers security teams to maintain organized, accessible, and secure visual resources, streamlining processes and safeguarding information limitations none to date additional docs for more information, refer to the https //lucid readme io/reference/overview prerequisites to effectively utilize the lucid chart connector with swimlane turbine, you must have oauth2 refresh token authentication with the following parameters url the endpoint url for lucid chart api access client id the client identifier as registered in lucid chart application settings client secret the secret key associated with your lucid chart client id refresh token a token used to obtain a new access token when the current access token expires http bearer token authentication with the following parameters url the endpoint url for lucid chart api access token a bearer token such as jwt to authenticate api requests capabilities this connector provides the following capabilities copy document create document create folder document contents folders get audit logs documents get folder get profile get user get/export document import document list folder contents list root folder contents users list users restore folder search documents and so on copy document copies one of the requesting user's existing documents, with the specified title lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/createorcopyorimportdocument ) create document creates a new document for the requesting user, with the specified title lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/createorcopyorimportdocument ) create folder create a new folder lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/createfolder ) document contents folders retrieves information about the contents of the requested lucidchart or lucidspark document lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/getdocumentcontent ) get audit logs documents lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/getauditlogs ) get folder retrieves information about the requested folder lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/getfolder ) get profile retrieves basic information about the authenticated user lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/getuserprofile ) get/export document retrieves information about the requested document lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/getorexportdocument ) get user retrieves information about the requested user lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/getuser ) import document imports an external non lucid file as a new document within lucid lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/createorcopyorimportdocument ) list folder contents retrieves basic information about the contents of a given folder lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/listfoldercontents ) list root folder contents users retrieves basic information about the contents of the root folder lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/listrootfoldercontents ) list users retrieves information about all users on the authenticated account lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/listusers ) restore folder move the given folder and all of its contents to their original pre trash locations lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/restorefolder ) search documents retrieves information about documents that the authenticated user has at least read only access to lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/searchdocuments ) search folders retrieves information about folders the authenticated user has at least read only access to lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/searchfolders ) search users by email retrieves information about all users on the authenticated user's account whose email is provided lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/useremailsearch ) trash document moves the specified document to the trash for the requesting user lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/trashdocument ) trash folder move the given folder and all of its contents into the trash lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/trashfolder ) update folder allows the requester to modify certain fields on a folder lucid chart documentation for this action can be found \[here] ( https //lucid readme io/reference/updatefolder ) configurations http bearer authentication authenticates using bearer token such as a jwt, etc configuration parameters parameter description type required url a url to the target host string required token the api key, token, etc string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional refresh token for lucid chart api authentication authenticates using refresh token configuration parameters parameter description type required url a url to the target host string required cl id the client id string required cl secret the client secret string required refresh token refresh token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions copy document creates a copy of an existing lucid chart document with a specified title and template, requiring headers and json body endpoint url /documents method post input argument name type required description headers object required http headers for the request headers lucid api version string required the api version used in the request title string optional the title of the copied document template string optional the id of the document to be copied parent number optional the id of the folder to contain the copied document input example {"json body" {"title" "copied document","template" "110808fd 4553 4316 bccf 4f25ff59a532","parent" 1234},"headers" {"lucid api version" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase documentid string unique identifier title string output field title editurl string url endpoint for the request viewurl string url endpoint for the request version number output field version pagecount number count value canedit boolean output field canedit created string output field created creatorid number unique identifier lastmodified string output field lastmodified lastmodifieduserid number unique identifier customattributes array output field customattributes customattributes file name string name of the resource customattributes file string output field customattributes file customtags array output field customtags product string output field product status string status value classification string output field classification trashed object output field trashed parent object output field parent owner object output field owner owner id number unique identifier owner type string type of the resource output example {"status code" 200,"reason" "ok","json body" {"documentid" "110808fd 4553 4316 bccf 4f25ff59a532","title" "document title","editurl" "https //lucid app/lucidchart/110808fd 4553 4316 bccf 4f25ff59a532/edit","viewurl" "https //lucid app/lucidchart/110808fd 4553 4316 bccf 4f25ff59a532/view","version" 101,"pagecount" 5,"canedit"\ false,"created" "2019 04 22t13 47 23z","creatorid" 12345,"lastmodified" "2020 06 26t16 29 37z","lastmodifieduserid" 54321,"customattributes" \[],"customtags" \["in progress"], create document generates a new lucid chart document with a specified title and product type, requiring headers and a json body endpoint url /documents method post input argument name type required description headers object required http headers for the request headers lucid api version string required the api version used in the request title string optional the title of the new document product string optional the product type for the new document parent number optional the id of the folder to contain the new document input example {"json body" {"title" "created document","product" "lucidchart","parent" 1234},"headers" {"lucid api version" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase documentid string unique identifier title string output field title editurl string url endpoint for the request viewurl string url endpoint for the request version number output field version pagecount number count value canedit boolean output field canedit created string output field created creatorid number unique identifier lastmodified string output field lastmodified lastmodifieduserid number unique identifier customattributes array output field customattributes customattributes file name string name of the resource customattributes file string output field customattributes file customtags array output field customtags product string output field product status string status value classification string output field classification trashed object output field trashed parent object output field parent owner object output field owner owner id number unique identifier owner type string type of the resource output example {"status code" 200,"reason" "ok","json body" {"documentid" "110808fd 4553 4316 bccf 4f25ff59a532","title" "document title","editurl" "https //lucid app/lucidchart/110808fd 4553 4316 bccf 4f25ff59a532/edit","viewurl" "https //lucid app/lucidchart/110808fd 4553 4316 bccf 4f25ff59a532/view","version" 101,"pagecount" 5,"canedit"\ false,"created" "2019 04 22t13 47 23z","creatorid" 12345,"lastmodified" "2020 06 26t16 29 37z","lastmodifieduserid" 54321,"customattributes" \[],"customtags" \["in progress"], create folder creates a new folder in lucid chart with specified 'name' and 'type', requiring headers and json body inputs endpoint url /folders method post input argument name type required description headers object required http headers for the request headers lucid api version number required the api version used in the request name string optional name of the folder being created type string optional type of folder being created parent number optional destination folder to create the new folder in input example {"json body" {"name" "folder name","type" "folder","parent" 12},"headers" {"lucid api version" 1}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier type string type of the resource name string name of the resource parent number output field parent created string output field created trashed string output field trashed attributes array output field attributes attributes name string name of the resource attributes value string value for the parameter output example {"status code" 200,"reason" "ok","json body" {"id" 123456789,"type" "folder","name" "folder name","parent" 123456788,"created" "2020 06 26t16 29 37z","trashed" "2022 01 20t12 14 18z","attributes" \[{}]}} document contents retrieves details of a lucid chart or lucidspark document using the document's unique id provided in path parameters endpoint url /documents/{{id}}/contents method get input argument name type required description path parameters id string required id of the document to have contents retrieved headers object required http headers for the request headers lucid api version number required the api version used in the request input example {"path parameters" {"id" "128e7b19ec 27ff 40e3 beb8 03f51b1661b"},"headers" {"lucid api version" 1}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier title string output field title product string output field product pages array output field pages pages file name string name of the resource pages file string output field pages file data object response data data collections array response data data collections file name string response data data collections file string response data output example {"status code" 200,"reason" "ok","json body" {"id" "8e7b19ec 27ff 40e3 beb8 03f51b1661b2","title" "document title","product" "lucidchart","pages" \[],"data" {"collections" \[]}}} get audit logs retrieves audit logs for the account, requiring specific headers and parameters to be set endpoint url /auditlogs method get input argument name type required description parameters from string optional the timestamp from which the audit logs will be returned defaults to 14 days prior to the "to" parameter if it is defined, otherwise 14 days prior to the current timestamp parameters to string optional the timestamp to which the logs will be returned defaults to the current timestamp parameters pagesize number optional the number of audit logs to return per request defaults to 200 parameters pagetoken string optional a token used for pagination to retrieve the next page of results when polling audit logs headers object required http headers for the request headers lucid api version string required the api version used in the request input example {"parameters" {"from" "2023 01 01t00 00 00z","to" "2023 01 31t23 59 59z","pagesize" 50,"pagetoken" "abc123"},"headers" {"lucid api version" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{"accountid" 1,"actor" {},"event" {},"target" \[],"flowid" "55ce2349da62cba"}]} get folder retrieves details for a specified folder in lucid chart using the folder's unique id provided in path parameters endpoint url /folders/{{id}} method get input argument name type required description path parameters id number required id of the folder to be retrieved headers object required http headers for the request headers lucid api version number required the api version used in the request input example {"path parameters" {"id" 123456789},"headers" {"lucid api version" 1}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier type string type of the resource name string name of the resource parent number output field parent created string output field created trashed string output field trashed attributes array output field attributes attributes name string name of the resource attributes value string value for the parameter output example {"status code" 200,"reason" "ok","json body" {"id" 123456789,"type" "folder","name" "folder name","parent" 123456788,"created" "2020 06 26t16 29 37z","trashed" "2022 01 20t12 14 18z","attributes" \[{}]}} get or export document retrieves information or exports the specified lucid chart document using its unique id provided in path parameters endpoint url /documents/{{id}} method get input argument name type required description parameters crop string optional specifies the crop settings for the document export optional for export operation parameters page number optional 1 based page index of the document to export defaults to the first page only a single page is allowed parameters pageid string optional specific page of the document to export only a single page is allowed path parameters id string required the id of the document to retrieve headers object required http headers for the request headers lucid api version number required the api version used in the request input example {"parameters" {"crop" "content","page" 1,"pageid" "j 65x x714o2"},"path parameters" {"id" "110808fd 4553 4316 bccf 4f25ff59a532"},"headers" {"lucid api version" 1}} output parameter type description status code number http status code of the response reason string response reason phrase documentid string unique identifier title string output field title editurl string url endpoint for the request viewurl string url endpoint for the request version number output field version pagecount number count value canedit boolean output field canedit created string output field created creatorid number unique identifier lastmodified string output field lastmodified lastmodifieduserid number unique identifier customattributes array output field customattributes customattributes file name string name of the resource customattributes file string output field customattributes file customtags array output field customtags product string output field product status string status value classification string output field classification trashed object output field trashed parent object output field parent owner object output field owner owner id number unique identifier owner type string type of the resource output example {"status code" 200,"reason" "ok","json body" {"documentid" "110808fd 4553 4316 bccf 4f25ff59a532","title" "document title","editurl" "https //lucid app/lucidchart/110808fd 4553 4316 bccf 4f25ff59a532/edit","viewurl" "https //lucid app/lucidchart/110808fd 4553 4316 bccf 4f25ff59a532/view","version" 101,"pagecount" 5,"canedit"\ false,"created" "2019 04 22t13 47 23z","creatorid" 12345,"lastmodified" "2020 06 26t16 29 37z","lastmodifieduserid" 54321,"customattributes" \[],"customtags" \["in progress"], get profile retrieves basic information about the authenticated lucid chart user, including headers endpoint url /users/me/profile method get input argument name type required description headers object required http headers for the request headers lucid api version string required the api version used in the request input example {"headers" {"lucid api version" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase accountid number unique identifier username string name of the resource email string output field email fullname string name of the resource id number unique identifier output example {"status code" 200,"reason" "ok","json body" {"accountid" 100,"username" "johndoe","email" "john doe\@example com","fullname" "john doe","id" 101}} get user retrieves detailed information about a specific user in lucid chart using the user's unique identifier endpoint url /users/{{id}} method get input argument name type required description path parameters id number required id of the user to be retrieved headers object required http headers for the request headers lucid api version string required the api version used in the request input example {"path parameters" {"id" 101},"headers" {"lucid api version" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase accountid number unique identifier email string output field email name string name of the resource userid number unique identifier username string name of the resource roles array output field roles output example {"status code" 200,"reason" "ok","json body" {"accountid" 100,"email" "john doe\@example com","name" "john doe","userid" 101,"username" "johndoe","roles" \["billing admin","team admin"]}} import document imports an external file into lucid chart as a new document, requiring headers, json body with type, product, and title, and files endpoint url /documents method post input argument name type required description headers object required http headers for the request headers lucid api version string required the api version used in the request files object required privately upload and analyse a file files file string optional parameter for import document files file name string optional name of the resource type string optional the type of file provided for import product string optional the product type for importing a document title string optional title that should be given to the newly imported document parent number optional id of the folder to create the new document in input example {"json body" {"file" "file lucid","type" "x application/vnd lucid standardimport","product" "lucidchart","title" "imported document","parent" 1234},"headers" {"lucid api version" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase documentid string unique identifier title string output field title editurl string url endpoint for the request viewurl string url endpoint for the request version number output field version pagecount number count value canedit boolean output field canedit created string output field created creatorid number unique identifier lastmodified string output field lastmodified lastmodifieduserid number unique identifier customattributes array output field customattributes customattributes file name string name of the resource customattributes file string output field customattributes file customtags array output field customtags product string output field product status string status value classification string output field classification trashed object output field trashed parent object output field parent owner object output field owner owner id number unique identifier owner type string type of the resource output example {"status code" 200,"reason" "ok","json body" {"documentid" "110808fd 4553 4316 bccf 4f25ff59a532","title" "document title","editurl" "https //lucid app/lucidchart/110808fd 4553 4316 bccf 4f25ff59a532/edit","viewurl" "https //lucid app/lucidchart/110808fd 4553 4316 bccf 4f25ff59a532/view","version" 101,"pagecount" 5,"canedit"\ false,"created" "2019 04 22t13 47 23z","creatorid" 12345,"lastmodified" "2020 06 26t16 29 37z","lastmodifieduserid" 54321,"customattributes" \[],"customtags" \["in progress"], list folder contents retrieves basic information about the contents within a specified lucid chart folder, identified by its unique id endpoint url /folders/{{id}}/contents method get input argument name type required description path parameters id string required id of the folder or root to retrieve contents of the authenticated user's root directory headers object required http headers for the request headers lucid api version string required the api version used in the request input example {"path parameters" {"id" "3fa85f64 5717 4562 b3fc 2c963f66afa6"},"headers" {"lucid api version" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{"id" "3fa85f64 5717 4562 b3fc 2c963f66afa6","type" "document","name" "folder name","shortcut"\ false,"product" "lucidchart"}]} list root folder contents retrieves basic information about the contents of the lucid chart root folder, requiring specific headers endpoint url /folders/root/contents method get input argument name type required description headers object required http headers for the request headers lucid api version string required the api version used in the request input example {"headers" {"lucid api version" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {},"reason" "ok","json body" \[{"id" "3fa85f64 5717 4562 b3fc 2c963f66afa6","type" "document","name" "folder name","shortcut"\ false,"product" "lucidchart"}]} list users retrieves information about all users associated with the authenticated lucid chart account, requiring specific headers endpoint url /users method get input argument name type required description headers object required http headers for the request headers lucid api version string required the api version used in the request input example {"headers" {"lucid api version" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{"accountid" 100,"email" "john doe\@example com","name" "john doe","userid" 101,"username" "johndoe","roles" \[]}]} restore folder moves a specified folder, along with all contents, back to its original location from the trash in lucid chart; requires folder 'id' endpoint url /folders/{{id}}/restore method post input argument name type required description path parameters id number required id of the folder to be restored from the trash headers object required http headers for the request headers lucid api version number required the api version used in the request input example {"path parameters" {"id" 123456789},"headers" {"lucid api version" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" {}} search documents retrieves details of lucid chart documents accessible by the user, requiring specific headers and a json body endpoint url /documents/search method post input argument name type required description headers object required http headers for the request headers lucid api version number required the api version used in the request product array optional array of lucid suite products to filter by createdstarttime string optional date and time to filter documents that have been created after createdendtime string optional date and time to filter documents that have been created before lastmodifiedafter string optional date and time to filter documents that have been modified after keywords string optional keywords to search against document content and titles input example {"json body" {"product" "lucidchart","createdstarttime" "2023 01 01t00 00 00z","createdendtime" "2023 12 31t23 59 59z","lastmodifiedafter" "2023 06 01t00 00 00z","keywords" "annual report"},"headers" {"lucid api version" 1}} output parameter type description status code number http status code of the response reason string response reason phrase documentid string unique identifier title string output field title editurl string url endpoint for the request viewurl string url endpoint for the request version number output field version pagecount number count value canedit boolean output field canedit created string output field created creatorid number unique identifier lastmodified string output field lastmodified lastmodifieduserid number unique identifier customattributes array output field customattributes customattributes file name string name of the resource customattributes file string output field customattributes file customtags array output field customtags product string output field product status string status value classification string output field classification trashed object output field trashed parent object output field parent owner object output field owner owner id number unique identifier owner type string type of the resource output example {"status code" 200,"reason" "ok","json body" {"documentid" "110808fd 4553 4316 bccf 4f25ff59a532","title" "document title","editurl" "https //lucid app/lucidchart/110808fd 4553 4316 bccf 4f25ff59a532/edit","viewurl" "https //lucid app/lucidchart/110808fd 4553 4316 bccf 4f25ff59a532/view","version" 101,"pagecount" 5,"canedit"\ false,"created" "2019 04 22t13 47 23z","creatorid" 12345,"lastmodified" "2020 06 26t16 29 37z","lastmodifieduserid" 54321,"customattributes" \[],"customtags" \["in progress"], search folders retrieves folder details accessible by the user in lucid chart, requiring 'type' as a json body input endpoint url /folders/search method post input argument name type required description headers object required http headers for the request headers lucid api version number required the api version used in the request headers lucid request as string required the user role to make the request as this header is only available to service accounts type string optional the type of item to search for userids array optional list of userids to include in search ownedbyusers boolean optional truthy if search results should only include documents owned by users specified by userids keywords string optional keywords to search against folder content and titles input example {"json body" {"type" "folder","userids" \[12,34,56],"ownedbyusers"\ true,"keywords" "testfolder"},"headers" {"lucid api version" 1,"lucid request as" "admin"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{"id" 123456789,"type" "folder","name" "folder name","parent" 123456788,"created" "2020 06 26t16 29 37z","trashed" "2022 01 20t12 14 18z","attributes" \[]}]} search users by email retrieves details for users associated with the provided email addresses in lucid chart endpoint url /users/searchbyemail method post input argument name type required description headers object optional http headers for the request headers lucid api version string optional the api version used in the request emails array optional array of email addresses to search for input example {"json body" {"emails" \["abc\@example com","tz\@yux com"]},"headers" {"lucid api version" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{"accountid" 100,"username" "johndoe","email" "john doe\@example com","fullname" "john doe","id" 101}]} trash document moves a specified lucid chart document to the trash using the document's unique id provided in path parameters endpoint url /documents/{{id}}/trash method post input argument name type required description path parameters id string required id of the document to be moved to the trash headers object required http headers for the request headers lucid api version number required the api version used in the request input example {"path parameters" {"id" "110808fd 4553 4316 bccf 4f25ff59a532"},"headers" {"lucid api version" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" {}} trash folder moves a specified folder, along with all its contents, to the trash in lucid chart using the folder's unique id endpoint url /folders/{{id}}/trash method post input argument name type required description path parameters id number required id of the folder to be moved to the trash headers object required http headers for the request headers lucid api version number required the api version used in the request input example {"path parameters" {"id" 123456789},"headers" {"lucid api version" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" {}} update folder modifies specified fields of a lucid chart folder using the folder's id and provided name in the request body endpoint url /folders/{{id}} method patch input argument name type required description path parameters id number required id of the folder to be updated headers object required http headers for the request headers lucid api version number required the api version used in the request name string optional new name for the folder being updated parent number optional new parent for the folder being updated input example {"json body" {"name" "test folder","parent" 12},"path parameters" {"id" 123456789},"headers" {"lucid api version" 1}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier type string type of the resource name string name of the resource parent number output field parent created string output field created trashed string output field trashed attributes array output field attributes attributes name string name of the resource attributes value string value for the parameter output example {"status code" 200,"reason" "ok","json body" {"id" 123456789,"type" "folder","name" "folder name","parent" 123456788,"created" "2020 06 26t16 29 37z","trashed" "2022 01 20t12 14 18z","attributes" \[{}]}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt