Jump to Content
Documentation
API Reference
Extension API
Custom Shapes
Formulas
Community
API Reference
Community
Moon (Dark Mode)
Sun (Light Mode)
Documentation
API Reference
Extension API
Custom Shapes
Formulas
ItemPrimaryKey
Search
CTRL-K
All
Documentation
Reference
Start typing to search…
JUMP TO
CTRL-/
Lucid Rest API
Lucid REST API
Headers
Authentication Methods
Keeping your API credentials secure
Lucid's FedRAMP environment
Using API Keys
Creating a key
Using the key
API Key Grants
Using OAuth 2.0
Client Creation
Authorization endpoints
Obtaining an access token
Using the access token
Refreshing the access token
Refresh token example script
Access Scopes
Limitations
General OAuth 2.0 errors
OAuth 2.0 Tokens
Create or Refresh Access Token
post
Introspect Access Token
post
Revoke Access Token
post
Reference
Accounts
Get Account Information
get
Legal Holds
Create Legal Hold
post
Get Legal Holds
get
Add Legal Hold Users
post
Remove Legal Hold Users
post
Edit Legal Hold
patch
Release Legal Hold
post
Get Legal Hold Users
get
Get Legal Hold Documents
get
Collaboration
Documents Collaboration
Get Document User Collaborator
get
Create/Update Document User Collaborator
put
Delete Document User Collaborator
delete
List Document User Collaborators
get
Get Document Team Collaborator
get
Create/Update Document Team Collaborator
put
Delete Document Team Collaborator
delete
Folders Collaboration
Get Folder User Collaborator
get
Create/Update Folder User Collaborator
put
Delete Folder User Collaborator
delete
List Folder User Collaborators
get
Get Folder Group Collaborator
get
Create/Update Folder Group Collaborator
put
Delete Folder Group Collaborator
delete
List Folder Group Collaborators
get
Get Folder Team Collaborator
get
Create/Update Folder Team Collaborator
put
Delete Folder Team Collaborator
delete
Documents
Search Account Documents
post
Create/Copy/Import Document
post
Get/Export Document
get
Trash Document
post
Search Documents
post
Document Contents
get
Document Access
Sharing
Share Link Security
Documents Sharing
Get Document Share Link
get
Update Document Share Link
patch
Delete Document Share Link
delete
Create Document Share Link
post
Document Embedding
Embed Viewer
get
Generate Embed Session Token
post
Folders
Get Folder
get
Update Folder
patch
Create Folder
post
Trash Folder
post
Restore Folder
post
Search Folders
post
List Folder Contents
get
List Root Folder Contents
get
Transfer Content
Transfer User Content
post
Users
Get User
get
List Users
get
Create User
post
Search Users By Email
post
Get Profile
get
Unfurling
Describe Link
post
Direct Embed
get
Embedding Utils
Get Document Embed
get
Delete Document Embed
delete
Get Document Embed Document
get
Create Document Embed
post
Change Document Embed Version
post
Document Picker
Generate Document Picker Token
post
Embedded Document Picker
get
Audit Logs
Get Audit Logs
get
Audit Log Events
Logins
Content
Administration
User
Actors and Targets
Teams
List Teams
get
Create Team
post
Get Team
get
List Users on Team
get
Add Users to Team
post
Remove Users from Team
post
Archive Team
post
Restore Team
post
Sharing
Accept Share Links
post
Lucid SCIM API
Lucid SCIM API
Users
Get User
get
Modify User
put
Modify User
patch
Get All Users
get
Create User
post
Groups
Get Group
get
Modify Group
put
Modify Group
patch
Delete Group
delete
Get All Groups
get
Create Group
post
Schemas
Get Schema
get
Get All Schemas
get
Service Provider Config
Get Service Provider Config
get
Extension SDK
Overview
globals
Classes
BaseFieldTypeArray
BlockProxy
CardBlockProxy
ColorLegendEntryProxy
CollectionEnumFieldType
CollectionProxy
CustomBlockProxy
DataConnector
DataConnectorAction
DataConnectorActionContext
DataConnectorManageWebhookAction
DataConnectorPatchAction
DataConnectorAsynchronousAction
DataConnectorRequestState
DataConnectorRequestError
DataConnectorClient
DataConnectorResponseError
DataConnectorSynchronousAction
DataConnectorRunError
DataError
DataItemProxy
DataProxy
DataSourceProxy
DocumentProxy
DataSourceClient
ERDBlockProxy
ERDFieldProxy
EditorClient
FieldTypeArray
FormattedPrimaryKey
HumanReadableError
ElementProxy
GroupProxy
IframeUI
ItemsPatchExhaustive
ItemsPatchInexhaustive
ItemProxy
LegendBlockProxy
LegendEntryProxy
LineProxy
LiteralFieldType
LinkUnfurlBlockProxy
LucidCardIntegration
LucidCardIntegrationRegistry
MapProxy
Menu
MockDataConnectorClient
MockDataSourceClient
MockSignatureValidator
Modal
PageProxy
NDimensionalFieldTypeArray
PatchChange
PropertyStoreProxy
Panel
ShapeDataProxy
SignatureValidator
ShapeLegendEntryProxy
ReferenceKeyProxy
SwimLaneBlockProxy
SwimLanePrimaryLaneProxy
TableColumnProxy
TableBlockProxy
TableCellProxy
UserProxy
TableRowProxy
Viewport
WriteableMapProxy
Webhook
Enumerations
BadgeLayerPos
BadgeResponsiveness
ConditionCombination
CollectionEnumFieldNames
ConnectedShapesCondition
DataErrorType
ContainmentConditions
CommandName
ConditionType
DataUpdateFilterType
DataGraphicIconSets
FieldConstraintType
FieldDisplayType
GetItemsAtSearchType
GetDocumentChunksType
HashAlgorithmEnum
GetLLMContextType
HorizontalBadgePos
LegendItemType
LineShape
MenuLocation
LucidCardFields
LucidProduct
MenuType
PanelLocation
ScalarFieldTypeEnum
OffsetType
ShapeDataConditions
OnClickHandlerKeys
MermaidDiagramType
StrokeStyle
RuleFormattingType
ShapeDataInheritance
SimpleImageFillPosition
ShapeTypeConditions
TextConditions
SemanticKind
StatusValues
TextMarkupNames
UnfurlCallbackType
VerticalBadgePos
UnfurlIframeAspectRatio
ZOrderOperation
UnfurlRefreshErrorType
AuthorizationFlowHandlerStage
Functions
actionsHeaderValidator
areDataGraphicIconIndexesEqual
areDataGraphicImagesEqual
arrayValidator
asAssertion
badgePositionsEqual
both
clip
boxesOverlap
boxFrom4Points
boxCenter
convertStrokeStyleToBorder
combinedBoundingBox
declareSchema
decodeBase64
deserializeActions
deserializeBaseFieldTypeDefinition
deserializeBadgeEnumPosition
deserializeCollectionEnumFieldType
deserializeFieldTypeArray
deserializeFieldTypeDefinition
deserializeNDimensionalFieldTypeArray
deserializeLiteralFieldType
deserializeShadow
deserializeSimpleStaticDataGraphicSettings
deserializeUpstreamConfig
either
encodeBase64
exclude
fieldTypesEqual
enumValidator
findProxyClass
flatten
fromEntries
generateIframeAttributes
isArray
isAny
isAtLeastLength
isBinaryXHRResponse
isBaseFieldTypeDefinition
isBoolean
isBooleanOrEmptyString
isBlockEndpointDefinition
isBoxWithin
isCollectionEnumFieldNames
isCollectionEnumFieldType
isBoundingBox
isDate
isDef
isDefAndNotNull
isEmptyOrNullishObject
isFalse
isFieldConstraintType
isFieldConstraintDefinition
isFlag
isExactLength
isFieldDisplayType
isHorizontalPos
isFunction
isImportedResults
isInfinite
isInstanceOf
isJsonSerializable
isLayerPos
isLiteral
isInt
isNDimensionalFieldTypeArray
isNull
isLineEndpointDefinition
isJsonObject
isLinearOffsetType
isJsonSerializedLucidDictionary
isLiteralFieldType
isNullOption
isNullish
isNestedSerializedLucidDictionary
isNumberOrEmptyString
isObject
isNumber
isObjectUnsafe
isObjectUnsafer
isOnClickHandlerKey
isPair
isPanelSize
isOpacity
isPartialTextStyle
isPointLike
isPositionEndpointDefinition
isPositiveNumber
isRawSendXHRResponse
isPromise
isScalarFieldTypeEnum
isSemanticKind
isRecord
isRestrictions
isSerializedBaseFieldTypeDefinition
isSerializedCollectionEnumFieldType
isSerializedDataError
isSerializedColorObjectFieldType
isSerializedFieldConstraint
isSerializedDataItems
isSerializedFieldDefinition
isSerializedFieldOption
isSerializedFieldOptions
isSerializedFields
isSerializedFieldTypeDefinition
isSerializedFieldTypeArray
isSerializedLiteralFieldType
isSerializedFieldType
isSerializedLucidCurrency
isSerializedLucidDateObject
isSerializedMetadataRecord
isSerializedMillisecondsDateObject
isSerializedNDimensionalFieldTypeArray
isSerializedJsonFieldType
isSerializedLucidDictionary
isSerializedSimpleStaticDataGraphicSettings
isSerializedSchema
isSerializedPreviewData
isSerializedSourceForeignKey
isSerializedSourceConfig
isString
isSize
isSet
isStrokeStyle
isSerializedTimeObject
isTextXHRResponse
isTrue
isStringOrNegativeOne
isValidSerializedBadgeEnumPosition
isUndefined
isTypedArray
isUnknown
isValidTypeForNDimensionalFieldTypeArray
isVerticalPos
isVoid
isXHRResponse
nullable
mapValidator
minLengthValidator
minMaxFieldConstraintValidator
maxLengthValidator
nullableOption
objectEvery
objectOfValidator
padBox
objectValidator
option
percentBoxesOverlap
rangeValidator
recordValidator
propertyValidator
partialObjectValidator
rotateAroundFn
rotateBox
schemaOKStatus
schemaOutOfSyncStatus
semanticKindToSemanticFields
rotatedBoundingBox
serializeCollectionPatch
serializeBadgeEnumPositionAsKey
serializeFieldTypeDefinition
serializeBadgeEnumPosition
serializeManageWebhookResponse
serializeBaseFieldTypeDefinition
serializePatchChanges
serializePatchResponse
serializeItemsPatch
serializeSimpleStaticDataGraphicSettings
serializeUpstreamConfig
someValidator
serializeShadow
strictObjectValidator
someValue
toCornersAsArray
stringEnumValidator
tupleValidator
typedRecordValidator
validatorWithMessage
unfurlRefreshErrorTypeValidator
isSerializedCardUserDataArray
isSerializedIsoDateObject
objectValidatorWithList
semanticKindToLucidFields
serializeSchemaForApi
isSerializedCardUserData
Interfaces
BadgeEnumPosition
BaseXHRResponse
BinaryXHRResponse
BlockEndpointDefinition
BlockDefinition
CollectionDefinition
CollectionPatch
Badgeable
CustomContentDockMenu
CustomDropdownMenu
CollectionReferenceKeyDefinition
CardIntegrationConfig
CustomMenuItem
EndpointStyle
CustomMenuConfig
FieldDefinition
ExtensionCardFieldOption
ExtensionCardFieldDefinition
FlattenedReferenceDefinition
FileUploadData
ImportResult
JsonObject
LineDefinition
LineEndpointDefinition
LineTextAreaPositioning
LockedFieldConstraintDefinition
MaxValueFieldConstraintDefinition
MaxLengthConstraintDefinition
LucidCardFieldDisplaySettings
MetadataRecord
MetadataPatch
MinValueFieldConstraintDefinition
NoWhitespaceFieldConstraintDefinition
OAuthXHRRequest
PageDefinition
PositionEndpointDefinition
RequiredFieldConstraintDefinition
SchemaDefinition
SerializedCollectionPatch
SearchResult
SerializedDataItems
SerializedReferenceKey
SerializedPreviewData
SerializedSourceConfig
SingleLineFieldConstraintDefinition
SetterOptions
StencilConfig
TextStyle
UnfurlCallbacks
Shadow
UnfurlThumbnail
UniqueEditFieldConstraintDefinition
UnfurlDetails
UnfurlIframe
TextXHRResponse
UpstreamConfig
XHRRequest
Type Aliases
AddCardIntegrationQuery
AddDiagramFromMermaidQuery
AddCardIntegrationResult
AddDiagramFromMermaidResult
AddLineTextAreaQuery
AddLineTextAreaResult
AddMenuItemQuery
AddMenuItemResult
AddShapeDataResult
AddShapeDataQuery
AddTableColumnQuery
AddTableColumnResult
AddTableRowQuery
AlertQuery
AddTableRowResult
AnimateViewportQuery
AnyFieldTypeArrayDefinition
AwaitDataSourceImportQuery
AlertResult
AnimateViewportResult
AwaitImportQuery
AwaitDataSourceImportResult
BaseFieldTypeDefinition
AwaitImportResult
BootstrapQuery
BootstrapResult
Box
BlockProxyConstructor
CalculateHashQuery
CalculateHashResult
CancelDragBlockToCanvasQuery
CanEditPackageSettingsQuery
CancelDragBlockToCanvasResult
CanEditPackageSettingsResult
CollectionId
Conditions
CommandArgs
ConfirmQuery
ConfirmResult
CreateBlockResult
CreateBlockQuery
CreateCardsQuery
CreateCardsResult
CreateCollectionFieldDefinition
CreateCollectionResult
CreateDataSourceQuery
CreateDocumentElementQuery
CreateDataSourceResult
CreateCollectionQuery
CreateGroupQuery
CreateGroupResult
CreateLineQuery
CreateDocumentElementResult
CreateLineResult
CreatePageResult
CreatePageQuery
CreateUserImageQuery
CreateUserImageResult
CustomBlockProxyConstructor
DataActionOptions
DataActionResponse
DataActionQuery
DataConnectorRoute
DataGraphicIconIndexes
DataGraphicIconLibrarySets
DeleteDocumentElementQuery
DeleteDocumentElementResult
DataItemExistsQuery
DataActionResult
DataItemExistsResult
DeleteItemResult
DataGraphicImage
DeletePageQuery
DataSourceRequest
DeleteShapeDataResult
DeleteTableColumnResult
DeletePageResult
DeleteTableRowResult
DownloadQuery
DeleteTableColumnQuery
DeleteTableRowQuery
DeleteItemQuery
DestructureGuardedTypeObj
DownloadResult
DragPointerMoveResult
DragPointerUpQuery
DeleteShapeDataQuery
DragPointerMoveQuery
DuplicateItemsResult
DuplicateItemsQuery
DragPointerUpResult
ElementExistsResult
ExecuteFormulaQuery
ElementExistsQuery
EndpointDefinition
FieldTypeArraySubTypes
ExecuteFormulaResult
FieldTypeDefinition
FireBeaconEventQuery
FindAvailableSpaceQuery
FormattingInterface
GetConnectedLinesResult
FindAvailableSpaceResult
GetConnectedLinesQuery
GetCurrentPageQuery
FireBeaconEventResult
GetCustomShapeQuery
GetCustomShapeResult
GetDataItemFieldQuery
FieldConstraintDefinition
GetDataItemFieldResult
GetDocumentAccessPermissionQuery
GetDocumentAccessPermissionResult
GetDocumentChunksResult
GetCurrentPageResult
GetDocumentChunksQuery
GetDocumentIdResult
GetElementTypeQuery
GetEnvironmentConfigQuery
GetItemPageIdQuery
GetDocumentIdQuery
GetEnvironmentConfigResult
GetElementTypeResult
GetItemsAtQuery
GetItemsAtResult
GetItemPageIdResult
GetLLMContextFromItemsQuery
GetOAuthClientIdQuery
GetLLMContextFromItemsResult
GetOAuthClientIdResult
GetOAuthTokenResult
GetPackageSettingsResult
GetPackageSettingsQuery
GetOAuthTokenQuery
GetProductResult
GetPropertyQuery
GetPropertyResult
GetReferenceKeyQuery
GetReferenceKeyResult
GetProductQuery
GetRelativeLinePositionQuery
GetRelativeLinePositionResult
GetShapeDataQuery
GetSelectionResult
GetSelectionQuery
GetSvgQuery
GetShapeDataResult
GetSvgResult
GetTextStyleQuery
GetTextStyleResult
GetVisibleRectQuery
GetUserIdResult
GetVisibleRectResult
GuardToType
GetUserIdQuery
HidePanelQuery
HideModalQuery
HidePanelResult
HideModalResult
HookAllChangesQuery
HookAllChangesResult
HookCreateItemsResult
HookCreateItemsQuery
HookDeleteItemsQuery
HookSelectionQuery
HookTextEditQuery
HookSelectionResult
HookDeleteItemsResult
ImportCardsQuery
ImportCardsResult
HookTextEditResult
ImageBadgeSettings
ImportPageQuery
ImportLinksQuery
ImportPageResult
ItemPrimaryKey
ItemType
ImportLinksResult
JsonArray
ItemsPatch
JsonSerializable
KillExtensionQuery
KillExtensionResult
LinearOffsetType
ListChildrenQuery
ListChildrenResult
ListCollectionFieldsQuery
ListCollectionFieldsResult
ListCollectionsQuery
ListCollectionsResult
ListDataItemsQuery
ListDataSourcesQuery
ListDataItemsResult
ListDataSourcesResult
ListDocumentElementsQuery
ListDocumentElementsResult
ListPagesQuery
ListPagesResult
ListPropertiesResult
ListReferenceKeysQuery
ListPropertiesQuery
ListShapeDataQuery
ListReferenceKeysResult
ListShapeDataResult
ListTextAreasQuery
ListTextAreasResult
LoadBlockClassesQuery
LoadBlockClassesResult
JSONSerializedLucidDictionary
MeasureTextQuery
MeasureTextResult
MetadataPatchResponse
ModalConfig
NestedSerializedLucidDictionary
OffsetItemsQuery
OffsetItemsResult
PatchChangeCollection
PatchDataItemsQuery
PanelConfig
PartialItemType
PatchItems
Point
PatchDataItemsResult
PromptResult
PromptQuery
RawSendXHRResponse
RawTriggerAuthFlowResult
RawCreateUserImageResult
RawDataActionResult
RegisterPanelQuery
ReferenceKeyDefinition
RegisterPanelResult
RegisterUnfurlResult
RegisterUnfurlQuery
ReloadExtensionQuery
SendAsyncOAuthRequestQuery
SendOAuthRequestQuery
SendOAuthRequestResponse
ReloadExtensionResult
SendPermanentTokenRequestQuery
SendUIMessageQuery
SendPermanentTokenRequestResponse
SendUIMessageResult
SendXHRResponseFormat
SerializedBadgeEnumPosition
SendXHRQuery
SerializedBaseFieldTypeDefinition
SendXHRResponse
SerializedCMYKColor
SerializedCollectionEnumFieldType
SerializedColorObject
SerializedCorrectedColor
SerializedFieldConstraint
SerializedColorObjectFieldType
SerializedFieldType
SerializedFieldDefinition
SerializedDataError
SerializedEffect
SerializedFieldTypeArray
SerializedIsoDateObject
SerializedFields
SerializedJsonFieldType
SerializedFieldTypeArraySubTypes
SerializedLabelOverrides
SerializedLiteralFieldType
SerializedFormatting
SerializedLucidCurrency
SerializedItemsPatch
SerializedLucidDateObject
SerializedFlattenedReference
SerializedFieldTypeDefinition
SerializedManageWebhookResponseBody
SerializedMillisecondsDateObject
SerializedNDimensionalFieldTypeArray
SerializedLucidDictionary
SerializedRGBColor
SerializedPatchResponseBody
SerializedPatchChange
SerializedShadow
SerializedReferenceKeyType
SerializedSourceForeignKey
SerializedTimeObject
SerializedSchema
SerializedSimpleStaticDataGraphicSettings
SetCurrentPageQuery
SetCurrentPageResult
SetPackageSettingsResult
SetPackageSettingsQuery
SetPropertyResult
SetReferenceKeyQuery
SetPropertyQuery
SetShapeDataResult
SetTextQuery
SetSelectionQuery
SetShapeDataQuery
SetReferenceKeyResult
ShowModalQuery
SetTextStyleResult
SetTextResult
ShowModalResult
SetSelectionResult
SetTextStyleQuery
ShowPackageSettingsModalResult
ShowPackageSettingsModalQuery
SimpleImageFill
ShowPanelResult
ShowPanelQuery
SimpleFillStyle
SimpleStaticDataGraphicSettings
StartDragBlockToCanvasQuery
SleepForTestCaseQuery
StartDragBlockToCanvasResult
SleepForTestCaseResult
StartPDFUploadRequestQuery
TextBadgeSettings
TextEditCompletionCallback
ThrowForTestCaseQuery
ThrowForTestCaseResult
TriggerAuthFlowQuery
TriggerAuthFlowResult
Tuple
TypedSerializedFlattenedReference
UnTypedSerializedFlattenedReference
UnhookAllChangesQuery
UnhookAllChangesResult
UnhookCreateItemsQuery
UnhookCreateItemsResult
UnhookSelectionQuery
UnhookSelectionResult
UnhookDeleteItemsResult
UnhookTextEditResult
Validator
UnhookTextEditQuery
ValidatorWithMessage
WithMutexResult
WithSilentActionsQuery
WithSilentActionsResult
WithUndefinedAsOptional
WithMutexQuery
WithUndefinedAsOptionalRecursive
XHRResponse
ZOrderResult
ZOrderQuery
UnhookDeleteItemsQuery
AddDiagramFromLumaQuery
AddAuthorizationFlowHandlerResult
AddDiagramFromLumaResult
AddAuthorizationFlowHandlerQuery
ExtensionCardUserDataSearch
AuthorizationFlowHandlerProvider
AddQuickActionQuery
ExtensionCardUserData
SerializedSchemaForApi
AddQuickActionResult
QuickActionTooltipQuery
ValidatorWithList
Variables
AnyScalarFieldType
DEFAULT_IFRAME_HEIGHT
CollectionEnumFieldTypeKey
DEFAULT_IFRAME_WIDTH
BadgePositionsClockwise
FlattenedReferenceKeyName
PatchErrorTooltipField
FlattenedReferenceKeyId
defaultBadgePositionSerialized
defaultBadgePosition
Lucid Data API
Legacy Data API
Rate Limits
Get Rate Limits
get
Data Set
Get Total Data Sets Count
head
Get All Data Sets
get
Create Data Set
post
Get Data Set
get
Update Data Set Name
patch
Delete Data Set
delete
Data Set Grant
Get Data Set Grant
get
Delete Data Set Grant
delete
Get All Data Set Grants
get
Create Data Set Grant
post
Data Set Properties
Get Data Set Properties
get
Update Data Set Properties
patch
Delete Data Set Properties
delete
Data Source
Get Total Data Sources Count
head
Get All Data Sources
get
Create Data Source
post
Get Data Source
get
Update Data Source
patch
Delete Data Source
delete
Create Data Source from CSV
post
Update Data Source from CSV
put
Data Source Grant
Get Data Source Grant
get
Delete Data Source Grant
delete
Get All Data Source Grants
get
Create Data Source Grant
post
Collection
Get Total Collections Count
head
Get All Collections
get
Create Collection
post
Get Collection
get
Update Collection
patch
Delete Collection
delete
Get All Metadata Collections
get
Create Metadata Collection
post
Collection Properties
Get Collection Properties
get
Update Collection Properties
patch
Delete Collection Properties
delete
Schema
Get Field Definition
get
Update Field Definition
patch
Delete Field Definition
delete
Get All Field Definitions
get
Update Field Definitions
patch
Delete Field Definitions
delete
Data Item
Get Total Data Items Count
head
Get All Data Items
get
Create Data Items
post
Update Data Items
patch
Delete Data Items
delete
Get Data Item
get
Get Data Items By Key
post
Update Data Item
patch
Delete Data Item
delete
Update Data Items By Key
patch
Delete Data Items By Key
delete
Data Item Filters
Lucid Legacy API
Other Legacy API
Visio
Import Visio File
post
Images
Images
get
ItemPrimaryKey
ts
type
ItemPrimaryKey
:
string
;
Updated 10 months ago
ImportPageResult
ItemType
Updated 10 months ago
ImportPageResult
ItemType
Lucid Rest API
Lucid REST API
Lucid's FedRAMP environment
Keeping your API credentials secure
Authentication Methods
Headers
Using API Keys
API Key Grants
Using the key
Creating a key
Using OAuth 2.0
General OAuth 2.0 errors
Limitations
Access Scopes
Refresh token example script
Refreshing the access token
Using the access token
Obtaining an access token
Authorization endpoints
Client Creation
OAuth 2.0 Tokens
Revoke Access Token
post
Introspect Access Token
post
Create or Refresh Access Token
post
Reference
Accounts
Get Account Information
get
Legal Holds
Get Legal Hold Documents
get
Get Legal Hold Users
get
Release Legal Hold
post
Edit Legal Hold
patch
Remove Legal Hold Users
post
Add Legal Hold Users
post
Get Legal Holds
get
Create Legal Hold
post
Collaboration
Folders Collaboration
Delete Folder Team Collaborator
delete
Create/Update Folder Team Collaborator
put
Get Folder Team Collaborator
get
List Folder Group Collaborators
get
Delete Folder Group Collaborator
delete
Create/Update Folder Group Collaborator
put
Get Folder Group Collaborator
get
List Folder User Collaborators
get
Delete Folder User Collaborator
delete
Create/Update Folder User Collaborator
put
Get Folder User Collaborator
get
Documents Collaboration
Delete Document Team Collaborator
delete
Create/Update Document Team Collaborator
put
Get Document Team Collaborator
get
List Document User Collaborators
get
Delete Document User Collaborator
delete
Create/Update Document User Collaborator
put
Get Document User Collaborator
get
Documents
Document Access
Document Contents
get
Search Documents
post
Trash Document
post
Get/Export Document
get
Create/Copy/Import Document
post
Search Account Documents
post
Sharing
Documents Sharing
Create Document Share Link
post
Delete Document Share Link
delete
Update Document Share Link
patch
Get Document Share Link
get
Share Link Security
Document Embedding
Generate Embed Session Token
post
Embed Viewer
get
Folders
List Root Folder Contents
get
List Folder Contents
get
Search Folders
post
Restore Folder
post
Trash Folder
post
Create Folder
post
Update Folder
patch
Get Folder
get
Transfer Content
Transfer User Content
post
Users
Get Profile
get
Search Users By Email
post
Create User
post
List Users
get
Get User
get
Unfurling
Direct Embed
get
Describe Link
post
Embedding Utils
Change Document Embed Version
post
Create Document Embed
post
Get Document Embed Document
get
Delete Document Embed
delete
Get Document Embed
get
Document Picker
Embedded Document Picker
get
Generate Document Picker Token
post
Audit Logs
Actors and Targets
Audit Log Events
User
Administration
Content
Logins
Get Audit Logs
get
Teams
Restore Team
post
Archive Team
post
Remove Users from Team
post
Add Users to Team
post
List Users on Team
get
Get Team
get
Create Team
post
List Teams
get
Sharing
Accept Share Links
post
Lucid SCIM API
Lucid SCIM API
Users
Create User
post
Get All Users
get
Modify User
patch
Modify User
put
Get User
get
Groups
Create Group
post
Get All Groups
get
Delete Group
delete
Modify Group
patch
Modify Group
put
Get Group
get
Schemas
Get All Schemas
get
Get Schema
get
Service Provider Config
Get Service Provider Config
get
Extension SDK
Overview
globals
Classes
Webhook
WriteableMapProxy
Viewport
TableRowProxy
UserProxy
TableCellProxy
TableBlockProxy
TableColumnProxy
SwimLanePrimaryLaneProxy
SwimLaneBlockProxy
ReferenceKeyProxy
ShapeLegendEntryProxy
SignatureValidator
ShapeDataProxy
Panel
PropertyStoreProxy
PatchChange
NDimensionalFieldTypeArray
PageProxy
Modal
MockSignatureValidator
MockDataSourceClient
MockDataConnectorClient
Menu
MapProxy
LucidCardIntegrationRegistry
LucidCardIntegration
LinkUnfurlBlockProxy
LiteralFieldType
LineProxy
LegendEntryProxy
LegendBlockProxy
ItemProxy
ItemsPatchInexhaustive
ItemsPatchExhaustive
IframeUI
GroupProxy
ElementProxy
HumanReadableError
FormattedPrimaryKey
FieldTypeArray
EditorClient
ERDFieldProxy
ERDBlockProxy
DataSourceClient
DocumentProxy
DataSourceProxy
DataProxy
DataItemProxy
DataError
DataConnectorRunError
DataConnectorSynchronousAction
DataConnectorResponseError
DataConnectorClient
DataConnectorRequestError
DataConnectorRequestState
DataConnectorAsynchronousAction
DataConnectorPatchAction
DataConnectorManageWebhookAction
DataConnectorActionContext
DataConnectorAction
DataConnector
CustomBlockProxy
CollectionProxy
CollectionEnumFieldType
ColorLegendEntryProxy
CardBlockProxy
BlockProxy
BaseFieldTypeArray
Enumerations
AuthorizationFlowHandlerStage
UnfurlRefreshErrorType
ZOrderOperation
UnfurlIframeAspectRatio
VerticalBadgePos
UnfurlCallbackType
TextMarkupNames
StatusValues
SemanticKind
TextConditions
ShapeTypeConditions
SimpleImageFillPosition
ShapeDataInheritance
RuleFormattingType
StrokeStyle
MermaidDiagramType
OnClickHandlerKeys
ShapeDataConditions
OffsetType
ScalarFieldTypeEnum
PanelLocation
MenuType
LucidProduct
LucidCardFields
MenuLocation
LineShape
LegendItemType
HorizontalBadgePos
GetLLMContextType
HashAlgorithmEnum
GetDocumentChunksType
GetItemsAtSearchType
FieldDisplayType
FieldConstraintType
DataGraphicIconSets
DataUpdateFilterType
ConditionType
CommandName
ContainmentConditions
DataErrorType
ConnectedShapesCondition
CollectionEnumFieldNames
ConditionCombination
BadgeResponsiveness
BadgeLayerPos
Functions
isSerializedCardUserData
serializeSchemaForApi
semanticKindToLucidFields
objectValidatorWithList
isSerializedIsoDateObject
isSerializedCardUserDataArray
unfurlRefreshErrorTypeValidator
validatorWithMessage
typedRecordValidator
tupleValidator
stringEnumValidator
toCornersAsArray
someValue
strictObjectValidator
serializeShadow
someValidator
serializeUpstreamConfig
serializeSimpleStaticDataGraphicSettings
serializeItemsPatch
serializePatchResponse
serializePatchChanges
serializeBaseFieldTypeDefinition
serializeManageWebhookResponse
serializeBadgeEnumPosition
serializeFieldTypeDefinition
serializeBadgeEnumPositionAsKey
serializeCollectionPatch
rotatedBoundingBox
semanticKindToSemanticFields
schemaOutOfSyncStatus
schemaOKStatus
rotateBox
rotateAroundFn
partialObjectValidator
propertyValidator
recordValidator
rangeValidator
percentBoxesOverlap
option
objectValidator
padBox
objectOfValidator
objectEvery
nullableOption
maxLengthValidator
minMaxFieldConstraintValidator
minLengthValidator
mapValidator
nullable
isXHRResponse
isVoid
isVerticalPos
isValidTypeForNDimensionalFieldTypeArray
isUnknown
isTypedArray
isUndefined
isValidSerializedBadgeEnumPosition
isStringOrNegativeOne
isTrue
isTextXHRResponse
isSerializedTimeObject
isStrokeStyle
isSet
isSize
isString
isSerializedSourceConfig
isSerializedSourceForeignKey
isSerializedPreviewData
isSerializedSchema
isSerializedSimpleStaticDataGraphicSettings
isSerializedLucidDictionary
isSerializedJsonFieldType
isSerializedNDimensionalFieldTypeArray
isSerializedMillisecondsDateObject
isSerializedMetadataRecord
isSerializedLucidDateObject
isSerializedLucidCurrency
isSerializedFieldType
isSerializedLiteralFieldType
isSerializedFieldTypeArray
isSerializedFieldTypeDefinition
isSerializedFields
isSerializedFieldOptions
isSerializedFieldOption
isSerializedFieldDefinition
isSerializedDataItems
isSerializedFieldConstraint
isSerializedColorObjectFieldType
isSerializedDataError
isSerializedCollectionEnumFieldType
isSerializedBaseFieldTypeDefinition
isRestrictions
isRecord
isSemanticKind
isScalarFieldTypeEnum
isPromise
isRawSendXHRResponse
isPositiveNumber
isPositionEndpointDefinition
isPointLike
isPartialTextStyle
isOpacity
isPanelSize
isPair
isOnClickHandlerKey
isObjectUnsafer
isObjectUnsafe
isNumber
isObject
isNumberOrEmptyString
isNestedSerializedLucidDictionary
isNullish
isNullOption
isLiteralFieldType
isJsonSerializedLucidDictionary
isLinearOffsetType
isJsonObject
isLineEndpointDefinition
isNull
isNDimensionalFieldTypeArray
isInt
isLiteral
isLayerPos
isJsonSerializable
isInstanceOf
isInfinite
isImportedResults
isFunction
isHorizontalPos
isFieldDisplayType
isExactLength
isFlag
isFieldConstraintDefinition
isFieldConstraintType
isFalse
isEmptyOrNullishObject
isDefAndNotNull
isDef
isDate
isBoundingBox
isCollectionEnumFieldType
isCollectionEnumFieldNames
isBoxWithin
isBlockEndpointDefinition
isBooleanOrEmptyString
isBoolean
isBaseFieldTypeDefinition
isBinaryXHRResponse
isAtLeastLength
isAny
isArray
generateIframeAttributes
fromEntries
flatten
findProxyClass
enumValidator
fieldTypesEqual
exclude
encodeBase64
either
deserializeUpstreamConfig
deserializeSimpleStaticDataGraphicSettings
deserializeShadow
deserializeLiteralFieldType
deserializeNDimensionalFieldTypeArray
deserializeFieldTypeDefinition
deserializeFieldTypeArray
deserializeCollectionEnumFieldType
deserializeBadgeEnumPosition
deserializeBaseFieldTypeDefinition
deserializeActions
decodeBase64
declareSchema
combinedBoundingBox
convertStrokeStyleToBorder
boxCenter
boxFrom4Points
boxesOverlap
clip
both
badgePositionsEqual
asAssertion
arrayValidator
areDataGraphicImagesEqual
areDataGraphicIconIndexesEqual
actionsHeaderValidator
Interfaces
XHRRequest
UpstreamConfig
TextXHRResponse
UnfurlIframe
UnfurlDetails
UniqueEditFieldConstraintDefinition
UnfurlThumbnail
Shadow
UnfurlCallbacks
TextStyle
StencilConfig
SetterOptions
SingleLineFieldConstraintDefinition
SerializedSourceConfig
SerializedPreviewData
SerializedReferenceKey
SerializedDataItems
SearchResult
SerializedCollectionPatch
SchemaDefinition
RequiredFieldConstraintDefinition
PositionEndpointDefinition
PageDefinition
OAuthXHRRequest
NoWhitespaceFieldConstraintDefinition
MinValueFieldConstraintDefinition
MetadataPatch
MetadataRecord
LucidCardFieldDisplaySettings
MaxLengthConstraintDefinition
MaxValueFieldConstraintDefinition
LockedFieldConstraintDefinition
LineTextAreaPositioning
LineEndpointDefinition
LineDefinition
JsonObject
ImportResult
FileUploadData
FlattenedReferenceDefinition
ExtensionCardFieldDefinition
ExtensionCardFieldOption
FieldDefinition
CustomMenuConfig
EndpointStyle
CustomMenuItem
CardIntegrationConfig
CollectionReferenceKeyDefinition
CustomDropdownMenu
CustomContentDockMenu
Badgeable
CollectionPatch
CollectionDefinition
BlockDefinition
BlockEndpointDefinition
BinaryXHRResponse
BaseXHRResponse
BadgeEnumPosition
Type Aliases
ValidatorWithList
QuickActionTooltipQuery
AddQuickActionResult
SerializedSchemaForApi
ExtensionCardUserData
AddQuickActionQuery
AuthorizationFlowHandlerProvider
ExtensionCardUserDataSearch
AddAuthorizationFlowHandlerQuery
AddDiagramFromLumaResult
AddAuthorizationFlowHandlerResult
AddDiagramFromLumaQuery
UnhookDeleteItemsQuery
ZOrderQuery
ZOrderResult
XHRResponse
WithUndefinedAsOptionalRecursive
WithMutexQuery
WithUndefinedAsOptional
WithSilentActionsResult
WithSilentActionsQuery
WithMutexResult
ValidatorWithMessage
UnhookTextEditQuery
Validator
UnhookTextEditResult
UnhookDeleteItemsResult
UnhookSelectionResult
UnhookSelectionQuery
UnhookCreateItemsResult
UnhookCreateItemsQuery
UnhookAllChangesResult
UnhookAllChangesQuery
UnTypedSerializedFlattenedReference
TypedSerializedFlattenedReference
Tuple
TriggerAuthFlowResult
TriggerAuthFlowQuery
ThrowForTestCaseResult
ThrowForTestCaseQuery
TextEditCompletionCallback
TextBadgeSettings
StartPDFUploadRequestQuery
SleepForTestCaseResult
StartDragBlockToCanvasResult
SleepForTestCaseQuery
StartDragBlockToCanvasQuery
SimpleStaticDataGraphicSettings
SimpleFillStyle
ShowPanelQuery
ShowPanelResult
SimpleImageFill
ShowPackageSettingsModalQuery
ShowPackageSettingsModalResult
SetTextStyleQuery
SetSelectionResult
ShowModalResult
SetTextResult
SetTextStyleResult
ShowModalQuery
SetReferenceKeyResult
SetShapeDataQuery
SetSelectionQuery
SetTextQuery
SetShapeDataResult
SetPropertyQuery
SetReferenceKeyQuery
SetPropertyResult
SetPackageSettingsQuery
SetPackageSettingsResult
SetCurrentPageResult
SetCurrentPageQuery
SerializedSimpleStaticDataGraphicSettings
SerializedSchema
SerializedTimeObject
SerializedSourceForeignKey
SerializedReferenceKeyType
SerializedShadow
SerializedPatchChange
SerializedPatchResponseBody
SerializedRGBColor
SerializedLucidDictionary
SerializedNDimensionalFieldTypeArray
SerializedMillisecondsDateObject
SerializedManageWebhookResponseBody
SerializedFieldTypeDefinition
SerializedFlattenedReference
SerializedLucidDateObject
SerializedItemsPatch
SerializedLucidCurrency
SerializedFormatting
SerializedLiteralFieldType
SerializedLabelOverrides
SerializedFieldTypeArraySubTypes
SerializedJsonFieldType
SerializedFields
SerializedIsoDateObject
SerializedFieldTypeArray
SerializedEffect
SerializedDataError
SerializedFieldDefinition
SerializedFieldType
SerializedColorObjectFieldType
SerializedFieldConstraint
SerializedCorrectedColor
SerializedColorObject
SerializedCollectionEnumFieldType
SerializedCMYKColor
SendXHRResponse
SerializedBaseFieldTypeDefinition
SendXHRQuery
SerializedBadgeEnumPosition
SendXHRResponseFormat
SendUIMessageResult
SendPermanentTokenRequestResponse
SendUIMessageQuery
SendPermanentTokenRequestQuery
ReloadExtensionResult
SendOAuthRequestResponse
SendOAuthRequestQuery
SendAsyncOAuthRequestQuery
ReloadExtensionQuery
RegisterUnfurlQuery
RegisterUnfurlResult
RegisterPanelResult
ReferenceKeyDefinition
RegisterPanelQuery
RawDataActionResult
RawCreateUserImageResult
RawTriggerAuthFlowResult
RawSendXHRResponse
PromptQuery
PromptResult
PatchDataItemsResult
Point
PatchItems
PartialItemType
PanelConfig
PatchDataItemsQuery
PatchChangeCollection
OffsetItemsResult
OffsetItemsQuery
NestedSerializedLucidDictionary
ModalConfig
MetadataPatchResponse
MeasureTextResult
MeasureTextQuery
JSONSerializedLucidDictionary
LoadBlockClassesResult
LoadBlockClassesQuery
ListTextAreasResult
ListTextAreasQuery
ListShapeDataResult
ListReferenceKeysResult
ListShapeDataQuery
ListPropertiesQuery
ListReferenceKeysQuery
ListPropertiesResult
ListPagesResult
ListPagesQuery
ListDocumentElementsResult
ListDocumentElementsQuery
ListDataSourcesResult
ListDataItemsResult
ListDataSourcesQuery
ListDataItemsQuery
ListCollectionsResult
ListCollectionsQuery
ListCollectionFieldsResult
ListCollectionFieldsQuery
ListChildrenResult
ListChildrenQuery
LinearOffsetType
KillExtensionResult
KillExtensionQuery
JsonSerializable
ItemsPatch
JsonArray
ImportLinksResult
ItemType
ItemPrimaryKey
ImportPageResult
ImportLinksQuery
ImportPageQuery
ImageBadgeSettings
HookTextEditResult
ImportCardsResult
ImportCardsQuery
HookDeleteItemsResult
HookSelectionResult
HookTextEditQuery
HookSelectionQuery
HookDeleteItemsQuery
HookCreateItemsQuery
HookCreateItemsResult
HookAllChangesResult
HookAllChangesQuery
HideModalResult
HidePanelResult
HideModalQuery
HidePanelQuery
GetUserIdQuery
GuardToType
GetVisibleRectResult
GetUserIdResult
GetVisibleRectQuery
GetTextStyleResult
GetTextStyleQuery
GetSvgResult
GetShapeDataResult
GetSvgQuery
GetSelectionQuery
GetSelectionResult
GetShapeDataQuery
GetRelativeLinePositionResult
GetRelativeLinePositionQuery
GetProductQuery
GetReferenceKeyResult
GetReferenceKeyQuery
GetPropertyResult
GetPropertyQuery
GetProductResult
GetOAuthTokenQuery
GetPackageSettingsQuery
GetPackageSettingsResult
GetOAuthTokenResult
GetOAuthClientIdResult
GetLLMContextFromItemsResult
GetOAuthClientIdQuery
GetLLMContextFromItemsQuery
GetItemPageIdResult
GetItemsAtResult
GetItemsAtQuery
GetElementTypeResult
GetEnvironmentConfigResult
GetDocumentIdQuery
GetItemPageIdQuery
GetEnvironmentConfigQuery
GetElementTypeQuery
GetDocumentIdResult
GetDocumentChunksQuery
GetCurrentPageResult
GetDocumentChunksResult
GetDocumentAccessPermissionResult
GetDocumentAccessPermissionQuery
GetDataItemFieldResult
FieldConstraintDefinition
GetDataItemFieldQuery
GetCustomShapeResult
GetCustomShapeQuery
FireBeaconEventResult
GetCurrentPageQuery
GetConnectedLinesQuery
FindAvailableSpaceResult
GetConnectedLinesResult
FormattingInterface
FindAvailableSpaceQuery
FireBeaconEventQuery
FieldTypeDefinition
ExecuteFormulaResult
FieldTypeArraySubTypes
EndpointDefinition
ElementExistsQuery
ExecuteFormulaQuery
ElementExistsResult
DragPointerUpResult
DuplicateItemsQuery
DuplicateItemsResult
DragPointerMoveQuery
DeleteShapeDataQuery
DragPointerUpQuery
DragPointerMoveResult
DownloadResult
DestructureGuardedTypeObj
DeleteItemQuery
DeleteTableRowQuery
DeleteTableColumnQuery
DownloadQuery
DeleteTableRowResult
DeletePageResult
DeleteTableColumnResult
DeleteShapeDataResult
DataSourceRequest
DeletePageQuery
DataGraphicImage
DeleteItemResult
DataItemExistsResult
DataActionResult
DataItemExistsQuery
DeleteDocumentElementResult
DeleteDocumentElementQuery
DataGraphicIconLibrarySets
DataGraphicIconIndexes
DataConnectorRoute
DataActionQuery
DataActionResponse
DataActionOptions
CustomBlockProxyConstructor
CreateUserImageResult
CreateUserImageQuery
CreatePageQuery
CreatePageResult
CreateLineResult
CreateDocumentElementResult
CreateLineQuery
CreateGroupResult
CreateGroupQuery
CreateCollectionQuery
CreateDataSourceResult
CreateDocumentElementQuery
CreateDataSourceQuery
CreateCollectionResult
CreateCollectionFieldDefinition
CreateCardsResult
CreateCardsQuery
CreateBlockQuery
CreateBlockResult
ConfirmResult
ConfirmQuery
CommandArgs
Conditions
CollectionId
CanEditPackageSettingsResult
CancelDragBlockToCanvasResult
CanEditPackageSettingsQuery
CancelDragBlockToCanvasQuery
CalculateHashResult
CalculateHashQuery
BlockProxyConstructor
Box
BootstrapResult
BootstrapQuery
AwaitImportResult
BaseFieldTypeDefinition
AwaitDataSourceImportResult
AwaitImportQuery
AnimateViewportResult
AlertResult
AwaitDataSourceImportQuery
AnyFieldTypeArrayDefinition
AnimateViewportQuery
AddTableRowResult
AlertQuery
AddTableRowQuery
AddTableColumnResult
AddTableColumnQuery
AddShapeDataQuery
AddShapeDataResult
AddMenuItemResult
AddMenuItemQuery
AddLineTextAreaResult
AddLineTextAreaQuery
AddDiagramFromMermaidResult
AddCardIntegrationResult
AddDiagramFromMermaidQuery
AddCardIntegrationQuery
Variables
defaultBadgePosition
defaultBadgePositionSerialized
FlattenedReferenceKeyId
PatchErrorTooltipField
FlattenedReferenceKeyName
BadgePositionsClockwise
DEFAULT_IFRAME_WIDTH
CollectionEnumFieldTypeKey
DEFAULT_IFRAME_HEIGHT
AnyScalarFieldType
Lucid Data API
Legacy Data API
Rate Limits
Get Rate Limits
get
Data Set
Delete Data Set
delete
Update Data Set Name
patch
Get Data Set
get
Create Data Set
post
Get All Data Sets
get
Get Total Data Sets Count
head
Data Set Grant
Create Data Set Grant
post
Get All Data Set Grants
get
Delete Data Set Grant
delete
Get Data Set Grant
get
Data Set Properties
Delete Data Set Properties
delete
Update Data Set Properties
patch
Get Data Set Properties
get
Data Source
Update Data Source from CSV
put
Create Data Source from CSV
post
Delete Data Source
delete
Update Data Source
patch
Get Data Source
get
Create Data Source
post
Get All Data Sources
get
Get Total Data Sources Count
head
Data Source Grant
Create Data Source Grant
post
Get All Data Source Grants
get
Delete Data Source Grant
delete
Get Data Source Grant
get
Collection
Create Metadata Collection
post
Get All Metadata Collections
get
Delete Collection
delete
Update Collection
patch
Get Collection
get
Create Collection
post
Get All Collections
get
Get Total Collections Count
head
Collection Properties
Delete Collection Properties
delete
Update Collection Properties
patch
Get Collection Properties
get
Schema
Delete Field Definitions
delete
Update Field Definitions
patch
Get All Field Definitions
get
Delete Field Definition
delete
Update Field Definition
patch
Get Field Definition
get
Data Item
Delete Data Items By Key
delete
Update Data Items By Key
patch
Delete Data Item
delete
Update Data Item
patch
Get Data Items By Key
post
Get Data Item
get
Delete Data Items
delete
Update Data Items
patch
Create Data Items
post
Get All Data Items
get
Get Total Data Items Count
head
Data Item Filters
Lucid Legacy API
Other Legacy API
Visio
Import Visio File
post
Images
Images
get
