---
title: Lucid Chart
slug: connectors/lucid-chart
docTags: 
createdAt: 2026-06-09T16:30:23.847Z
---

Lucidchart is a web-based diagramming tool that enables users to create and collaborate on visual content.

Lucid Chart is a leading visual collaboration suite that enables teams to create, share, and collaborate on diagrams and flowcharts. The Lucid Chart connector for Swimlane Turbine allows users to automate the management of diagrams and documents, enhancing productivity and collaboration. By integrating Lucid Chart with Swimlane Turbine, users can streamline document creation, retrieval, and management processes, enabling efficient workflow automation and improved security operations.

### Limitations

None to date.

## Additional Docs

For more information, refer to the [Lucid Chart API documentation](https://lucid.readme.io/reference/overview).

## Prerequisites

Before you can use the Lucidchart connector for Turbine, you'll need access to the Lucidchart API. This requires the following:

- HTTP Bearer authentication using the following parameters:
  - URL: The endpoint URL for accessing Lucidchart API.
  - Token: A bearer token such as a JWT for authorization.
- OAuth2 Refresh Token authentication using the following parameters:
  - URL: The endpoint URL for accessing Lucidchart API.
  - Client ID: The client identifier issued during registration.
  - Client Secret: The client secret associated with the client ID.
  - Refresh Token: A token used to obtain a new access token when the current one expires.

## 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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://lucid.readme.io/reference/updatefolder)).

## Additional Documentation

- [Lucid Chart Connector Documentation](https://docs.swimlane.com/connectors/lucid-chart)
- [Lucid Chart API Documentation](https://developer.lucid.co/api/v1/reference/)

# 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

Create 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

Generate 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

Create 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

Retrieve 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

Retrieve audit logs for the Lucid Chart account by setting specific headers and parameters.

### 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

Retrieve 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

Retrieve or export a specified Lucid Chart document using its unique ID in path parameters and required headers.

### 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

Retrieve 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

Retrieve 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

Import an external file into Lucid Chart as a new document. Requires 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

Retrieve basic information about contents within a specified Lucid Chart folder using 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

Retrieve 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

Retrieve information about all users associated with the authenticated Lucid Chart account. Requires 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

Move a specified folder and its contents back to the original location from the trash in Lucid Chart. Requires the folder 'id' as a path parameter.

### 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

Retrieve 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

Retrieve folder details accessible by the user in Lucid Chart. Requires 'type' as a JSON body input along with headers.

### 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

Retrieve user details associated with provided email addresses in Lucid Chart. Requires a JSON body containing the emails.

### 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

Move 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

Move a specified folder and 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

Modify 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 |