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
AddTableRowResult
Search
JUMP TO
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
Audit Logs
Get Audit Logs
get
Audit Log Events
Logins
Content
Administration
Actors and Targets
Collaboration
Documents Collaboration
Get Document User Collaborator
get
Create/Update Document User Collaborator
put
Delete Document User Collaborator
delete
List Document User Collaborators
get
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
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
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
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
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
AddTableRowResult
ts
type AddTableRowResult: number;
The index of the newly created row