JUMP TOLucid Rest APILucid REST APIHeadersAuthentication MethodsKeeping your API credentials secureLucid's FedRAMP environmentUsing API KeysCreating a keyUsing the keyAPI Key GrantsUsing OAuth 2.0Client CreationAuthorization endpointsObtaining an access tokenUsing the access tokenRefreshing the access tokenRefresh token example scriptAccess ScopesLimitationsGeneral OAuth 2.0 errorsOAuth 2.0 TokensCreate or Refresh Access TokenpostIntrospect Access TokenpostRevoke Access TokenpostReferenceAccountsGet Account InformationgetAudit LogsGet Audit LogsgetAudit Log EventsLoginsContentAdministrationActors and TargetsCollaborationDocuments CollaborationGet Document User CollaboratorgetCreate/Update Document User CollaboratorputDelete Document User CollaboratordeleteList Document User CollaboratorsgetFolders CollaborationGet Folder User CollaboratorgetCreate/Update Folder User CollaboratorputDelete Folder User CollaboratordeleteList Folder User CollaboratorsgetGet Folder Group CollaboratorgetCreate/Update Folder Group CollaboratorputDelete Folder Group CollaboratordeleteList Folder Group CollaboratorsgetDocumentsSearch Account DocumentspostCreate/Copy/Import DocumentpostGet/Export DocumentgetTrash DocumentpostSearch DocumentspostDocument ContentsgetDocument AccessSharingShare Link SecurityDocuments SharingGet Document Share LinkgetUpdate Document Share LinkpatchDelete Document Share LinkdeleteCreate Document Share LinkpostLegal HoldsCreate Legal HoldpostGet Legal HoldsgetAdd Legal Hold UserspostRemove Legal Hold UserspostEdit Legal HoldpatchRelease Legal HoldpostGet Legal Hold UsersgetGet Legal Hold DocumentsgetDocument EmbeddingEmbed ViewergetGenerate Embed Session TokenpostFoldersGet FoldergetUpdate FolderpatchCreate FolderpostTrash FolderpostRestore FolderpostSearch FolderspostList Folder ContentsgetList Root Folder ContentsgetTransfer ContentTransfer User ContentpostUsersGet UsergetList UsersgetCreate UserpostSearch Users By EmailpostGet ProfilegetUnfurlingDescribe LinkpostDirect EmbedgetEmbedding UtilsGet Document EmbedgetDelete Document EmbeddeleteGet Document Embed DocumentgetCreate Document EmbedpostChange Document Embed VersionpostDocument PickerGenerate Document Picker TokenpostEmbedded Document PickergetSharingAccept Share LinkspostLucid SCIM APILucid SCIM APIUsersGet UsergetModify UserputModify UserpatchGet All UsersgetCreate UserpostGroupsGet GroupgetModify GroupputModify GrouppatchDelete GroupdeleteGet All GroupsgetCreate GrouppostSchemasGet SchemagetGet All SchemasgetService Provider ConfigGet Service Provider ConfiggetExtension SDKOverviewglobalsClassesBaseFieldTypeArrayBlockProxyCardBlockProxyColorLegendEntryProxyCollectionEnumFieldTypeCollectionProxyCustomBlockProxyDataConnectorDataConnectorActionDataConnectorActionContextDataConnectorManageWebhookActionDataConnectorPatchActionDataConnectorAsynchronousActionDataConnectorRequestStateDataConnectorRequestErrorDataConnectorClientDataConnectorResponseErrorDataConnectorSynchronousActionDataConnectorRunErrorDataErrorDataItemProxyDataProxyDataSourceProxyDocumentProxyDataSourceClientERDBlockProxyERDFieldProxyEditorClientFieldTypeArrayFormattedPrimaryKeyHumanReadableErrorElementProxyGroupProxyIframeUIItemsPatchExhaustiveItemsPatchInexhaustiveItemProxyLegendBlockProxyLegendEntryProxyLineProxyLiteralFieldTypeLinkUnfurlBlockProxyLucidCardIntegrationLucidCardIntegrationRegistryMapProxyMenuMockDataConnectorClientMockDataSourceClientMockSignatureValidatorModalPageProxyNDimensionalFieldTypeArrayPatchChangePropertyStoreProxyPanelShapeDataProxySignatureValidatorShapeLegendEntryProxyReferenceKeyProxySwimLaneBlockProxySwimLanePrimaryLaneProxyTableColumnProxyTableBlockProxyTableCellProxyUserProxyTableRowProxyViewportWriteableMapProxyWebhookEnumerationsBadgeLayerPosBadgeResponsivenessConditionCombinationCollectionEnumFieldNamesConnectedShapesConditionDataErrorTypeContainmentConditionsCommandNameConditionTypeDataUpdateFilterTypeDataGraphicIconSetsFieldConstraintTypeFieldDisplayTypeGetItemsAtSearchTypeGetDocumentChunksTypeHashAlgorithmEnumGetLLMContextTypeHorizontalBadgePosLegendItemTypeLineShapeMenuLocationLucidCardFieldsLucidProductMenuTypePanelLocationScalarFieldTypeEnumOffsetTypeShapeDataConditionsOnClickHandlerKeysMermaidDiagramTypeStrokeStyleRuleFormattingTypeShapeDataInheritanceSimpleImageFillPositionShapeTypeConditionsTextConditionsSemanticKindStatusValuesTextMarkupNamesUnfurlCallbackTypeVerticalBadgePosUnfurlIframeAspectRatioZOrderOperationUnfurlRefreshErrorTypeAuthorizationFlowHandlerStageFunctionsactionsHeaderValidatorareDataGraphicIconIndexesEqualareDataGraphicImagesEqualarrayValidatorasAssertionbadgePositionsEqualbothclipboxesOverlapboxFrom4PointsboxCenterconvertStrokeStyleToBordercombinedBoundingBoxdeclareSchemadecodeBase64deserializeActionsdeserializeBaseFieldTypeDefinitiondeserializeBadgeEnumPositiondeserializeCollectionEnumFieldTypedeserializeFieldTypeArraydeserializeFieldTypeDefinitiondeserializeNDimensionalFieldTypeArraydeserializeLiteralFieldTypedeserializeShadowdeserializeSimpleStaticDataGraphicSettingsdeserializeUpstreamConfigeitherencodeBase64excludefieldTypesEqualenumValidatorfindProxyClassflattenfromEntriesgenerateIframeAttributesisArrayisAnyisAtLeastLengthisBinaryXHRResponseisBaseFieldTypeDefinitionisBooleanisBooleanOrEmptyStringisBlockEndpointDefinitionisBoxWithinisCollectionEnumFieldNamesisCollectionEnumFieldTypeisBoundingBoxisDateisDefisDefAndNotNullisEmptyOrNullishObjectisFalseisFieldConstraintTypeisFieldConstraintDefinitionisFlagisExactLengthisFieldDisplayTypeisHorizontalPosisFunctionisImportedResultsisInfiniteisInstanceOfisJsonSerializableisLayerPosisLiteralisIntisNDimensionalFieldTypeArrayisNullisLineEndpointDefinitionisJsonObjectisLinearOffsetTypeisJsonSerializedLucidDictionaryisLiteralFieldTypeisNullOptionisNullishisNestedSerializedLucidDictionaryisNumberOrEmptyStringisObjectisNumberisObjectUnsafeisObjectUnsaferisOnClickHandlerKeyisPairisPanelSizeisOpacityisPartialTextStyleisPointLikeisPositionEndpointDefinitionisPositiveNumberisRawSendXHRResponseisPromiseisScalarFieldTypeEnumisSemanticKindisRecordisRestrictionsisSerializedBaseFieldTypeDefinitionisSerializedCollectionEnumFieldTypeisSerializedDataErrorisSerializedColorObjectFieldTypeisSerializedFieldConstraintisSerializedDataItemsisSerializedFieldDefinitionisSerializedFieldOptionisSerializedFieldOptionsisSerializedFieldsisSerializedFieldTypeDefinitionisSerializedFieldTypeArrayisSerializedLiteralFieldTypeisSerializedFieldTypeisSerializedLucidCurrencyisSerializedLucidDateObjectisSerializedMetadataRecordisSerializedMillisecondsDateObjectisSerializedNDimensionalFieldTypeArrayisSerializedJsonFieldTypeisSerializedLucidDictionaryisSerializedSimpleStaticDataGraphicSettingsisSerializedSchemaisSerializedPreviewDataisSerializedSourceForeignKeyisSerializedSourceConfigisStringisSizeisSetisStrokeStyleisSerializedTimeObjectisTextXHRResponseisTrueisStringOrNegativeOneisValidSerializedBadgeEnumPositionisUndefinedisTypedArrayisUnknownisValidTypeForNDimensionalFieldTypeArrayisVerticalPosisVoidisXHRResponsenullablemapValidatorminLengthValidatorminMaxFieldConstraintValidatormaxLengthValidatornullableOptionobjectEveryobjectOfValidatorpadBoxobjectValidatoroptionpercentBoxesOverlaprangeValidatorrecordValidatorpropertyValidatorpartialObjectValidatorrotateAroundFnrotateBoxschemaOKStatusschemaOutOfSyncStatussemanticKindToSemanticFieldsrotatedBoundingBoxserializeCollectionPatchserializeBadgeEnumPositionAsKeyserializeFieldTypeDefinitionserializeBadgeEnumPositionserializeManageWebhookResponseserializeBaseFieldTypeDefinitionserializePatchChangesserializePatchResponseserializeItemsPatchserializeSimpleStaticDataGraphicSettingsserializeUpstreamConfigsomeValidatorserializeShadowstrictObjectValidatorsomeValuetoCornersAsArraystringEnumValidatortupleValidatortypedRecordValidatorvalidatorWithMessageunfurlRefreshErrorTypeValidatorisSerializedCardUserDataArrayisSerializedIsoDateObjectobjectValidatorWithListsemanticKindToLucidFieldsserializeSchemaForApiisSerializedCardUserDataInterfacesBadgeEnumPositionBaseXHRResponseBinaryXHRResponseBlockEndpointDefinitionBlockDefinitionCollectionDefinitionCollectionPatchBadgeableCustomContentDockMenuCustomDropdownMenuCollectionReferenceKeyDefinitionCardIntegrationConfigCustomMenuItemEndpointStyleCustomMenuConfigFieldDefinitionExtensionCardFieldOptionExtensionCardFieldDefinitionFlattenedReferenceDefinitionFileUploadDataImportResultJsonObjectLineDefinitionLineEndpointDefinitionLineTextAreaPositioningLockedFieldConstraintDefinitionMaxValueFieldConstraintDefinitionMaxLengthConstraintDefinitionLucidCardFieldDisplaySettingsMetadataRecordMetadataPatchMinValueFieldConstraintDefinitionNoWhitespaceFieldConstraintDefinitionOAuthXHRRequestPageDefinitionPositionEndpointDefinitionRequiredFieldConstraintDefinitionSchemaDefinitionSerializedCollectionPatchSearchResultSerializedDataItemsSerializedReferenceKeySerializedPreviewDataSerializedSourceConfigSingleLineFieldConstraintDefinitionSetterOptionsStencilConfigTextStyleUnfurlCallbacksShadowUnfurlThumbnailUniqueEditFieldConstraintDefinitionUnfurlDetailsUnfurlIframeTextXHRResponseUpstreamConfigXHRRequestType AliasesAddCardIntegrationQueryAddDiagramFromMermaidQueryAddCardIntegrationResultAddDiagramFromMermaidResultAddLineTextAreaQueryAddLineTextAreaResultAddMenuItemQueryAddMenuItemResultAddShapeDataResultAddShapeDataQueryAddTableColumnQueryAddTableColumnResultAddTableRowQueryAlertQueryAddTableRowResultAnimateViewportQueryAnyFieldTypeArrayDefinitionAwaitDataSourceImportQueryAlertResultAnimateViewportResultAwaitImportQueryAwaitDataSourceImportResultBaseFieldTypeDefinitionAwaitImportResultBootstrapQueryBootstrapResultBoxBlockProxyConstructorCalculateHashQueryCalculateHashResultCancelDragBlockToCanvasQueryCanEditPackageSettingsQueryCancelDragBlockToCanvasResultCanEditPackageSettingsResultCollectionIdConditionsCommandArgsConfirmQueryConfirmResultCreateBlockResultCreateBlockQueryCreateCardsQueryCreateCardsResultCreateCollectionFieldDefinitionCreateCollectionResultCreateDataSourceQueryCreateDocumentElementQueryCreateDataSourceResultCreateCollectionQueryCreateGroupQueryCreateGroupResultCreateLineQueryCreateDocumentElementResultCreateLineResultCreatePageResultCreatePageQueryCreateUserImageQueryCreateUserImageResultCustomBlockProxyConstructorDataActionOptionsDataActionResponseDataActionQueryDataConnectorRouteDataGraphicIconIndexesDataGraphicIconLibrarySetsDeleteDocumentElementQueryDeleteDocumentElementResultDataItemExistsQueryDataActionResultDataItemExistsResultDeleteItemResultDataGraphicImageDeletePageQueryDataSourceRequestDeleteShapeDataResultDeleteTableColumnResultDeletePageResultDeleteTableRowResultDownloadQueryDeleteTableColumnQueryDeleteTableRowQueryDeleteItemQueryDestructureGuardedTypeObjDownloadResultDragPointerMoveResultDragPointerUpQueryDeleteShapeDataQueryDragPointerMoveQueryDuplicateItemsResultDuplicateItemsQueryDragPointerUpResultElementExistsResultExecuteFormulaQueryElementExistsQueryEndpointDefinitionFieldTypeArraySubTypesExecuteFormulaResultFieldTypeDefinitionFireBeaconEventQueryFindAvailableSpaceQueryFormattingInterfaceGetConnectedLinesResultFindAvailableSpaceResultGetConnectedLinesQueryGetCurrentPageQueryFireBeaconEventResultGetCustomShapeQueryGetCustomShapeResultGetDataItemFieldQueryFieldConstraintDefinitionGetDataItemFieldResultGetDocumentAccessPermissionQueryGetDocumentAccessPermissionResultGetDocumentChunksResultGetCurrentPageResultGetDocumentChunksQueryGetDocumentIdResultGetElementTypeQueryGetEnvironmentConfigQueryGetItemPageIdQueryGetDocumentIdQueryGetEnvironmentConfigResultGetElementTypeResultGetItemsAtQueryGetItemsAtResultGetItemPageIdResultGetLLMContextFromItemsQueryGetOAuthClientIdQueryGetLLMContextFromItemsResultGetOAuthClientIdResultGetOAuthTokenResultGetPackageSettingsResultGetPackageSettingsQueryGetOAuthTokenQueryGetProductResultGetPropertyQueryGetPropertyResultGetReferenceKeyQueryGetReferenceKeyResultGetProductQueryGetRelativeLinePositionQueryGetRelativeLinePositionResultGetShapeDataQueryGetSelectionResultGetSelectionQueryGetSvgQueryGetShapeDataResultGetSvgResultGetTextStyleQueryGetTextStyleResultGetVisibleRectQueryGetUserIdResultGetVisibleRectResultGuardToTypeGetUserIdQueryHidePanelQueryHideModalQueryHidePanelResultHideModalResultHookAllChangesQueryHookAllChangesResultHookCreateItemsResultHookCreateItemsQueryHookDeleteItemsQueryHookSelectionQueryHookTextEditQueryHookSelectionResultHookDeleteItemsResultImportCardsQueryImportCardsResultHookTextEditResultImageBadgeSettingsImportPageQueryImportLinksQueryImportPageResultItemPrimaryKeyItemTypeImportLinksResultJsonArrayItemsPatchJsonSerializableKillExtensionQueryKillExtensionResultLinearOffsetTypeListChildrenQueryListChildrenResultListCollectionFieldsQueryListCollectionFieldsResultListCollectionsQueryListCollectionsResultListDataItemsQueryListDataSourcesQueryListDataItemsResultListDataSourcesResultListDocumentElementsQueryListDocumentElementsResultListPagesQueryListPagesResultListPropertiesResultListReferenceKeysQueryListPropertiesQueryListShapeDataQueryListReferenceKeysResultListShapeDataResultListTextAreasQueryListTextAreasResultLoadBlockClassesQueryLoadBlockClassesResultJSONSerializedLucidDictionaryMeasureTextQueryMeasureTextResultMetadataPatchResponseModalConfigNestedSerializedLucidDictionaryOffsetItemsQueryOffsetItemsResultPatchChangeCollectionPatchDataItemsQueryPanelConfigPartialItemTypePatchItemsPointPatchDataItemsResultPromptResultPromptQueryRawSendXHRResponseRawTriggerAuthFlowResultRawCreateUserImageResultRawDataActionResultRegisterPanelQueryReferenceKeyDefinitionRegisterPanelResultRegisterUnfurlResultRegisterUnfurlQueryReloadExtensionQuerySendAsyncOAuthRequestQuerySendOAuthRequestQuerySendOAuthRequestResponseReloadExtensionResultSendPermanentTokenRequestQuerySendUIMessageQuerySendPermanentTokenRequestResponseSendUIMessageResultSendXHRResponseFormatSerializedBadgeEnumPositionSendXHRQuerySerializedBaseFieldTypeDefinitionSendXHRResponseSerializedCMYKColorSerializedCollectionEnumFieldTypeSerializedColorObjectSerializedCorrectedColorSerializedFieldConstraintSerializedColorObjectFieldTypeSerializedFieldTypeSerializedFieldDefinitionSerializedDataErrorSerializedEffectSerializedFieldTypeArraySerializedIsoDateObjectSerializedFieldsSerializedJsonFieldTypeSerializedFieldTypeArraySubTypesSerializedLabelOverridesSerializedLiteralFieldTypeSerializedFormattingSerializedLucidCurrencySerializedItemsPatchSerializedLucidDateObjectSerializedFlattenedReferenceSerializedFieldTypeDefinitionSerializedManageWebhookResponseBodySerializedMillisecondsDateObjectSerializedNDimensionalFieldTypeArraySerializedLucidDictionarySerializedRGBColorSerializedPatchResponseBodySerializedPatchChangeSerializedShadowSerializedReferenceKeyTypeSerializedSourceForeignKeySerializedTimeObjectSerializedSchemaSerializedSimpleStaticDataGraphicSettingsSetCurrentPageQuerySetCurrentPageResultSetPackageSettingsResultSetPackageSettingsQuerySetPropertyResultSetReferenceKeyQuerySetPropertyQuerySetShapeDataResultSetTextQuerySetSelectionQuerySetShapeDataQuerySetReferenceKeyResultShowModalQuerySetTextStyleResultSetTextResultShowModalResultSetSelectionResultSetTextStyleQueryShowPackageSettingsModalResultShowPackageSettingsModalQuerySimpleImageFillShowPanelResultShowPanelQuerySimpleFillStyleSimpleStaticDataGraphicSettingsStartDragBlockToCanvasQuerySleepForTestCaseQueryStartDragBlockToCanvasResultSleepForTestCaseResultStartPDFUploadRequestQueryTextBadgeSettingsTextEditCompletionCallbackThrowForTestCaseQueryThrowForTestCaseResultTriggerAuthFlowQueryTriggerAuthFlowResultTupleTypedSerializedFlattenedReferenceUnTypedSerializedFlattenedReferenceUnhookAllChangesQueryUnhookAllChangesResultUnhookCreateItemsQueryUnhookCreateItemsResultUnhookSelectionQueryUnhookSelectionResultUnhookDeleteItemsResultUnhookTextEditResultValidatorUnhookTextEditQueryValidatorWithMessageWithMutexResultWithSilentActionsQueryWithSilentActionsResultWithUndefinedAsOptionalWithMutexQueryWithUndefinedAsOptionalRecursiveXHRResponseZOrderResultZOrderQueryUnhookDeleteItemsQueryAddDiagramFromLumaQueryAddAuthorizationFlowHandlerResultAddDiagramFromLumaResultAddAuthorizationFlowHandlerQueryExtensionCardUserDataSearchAuthorizationFlowHandlerProviderAddQuickActionQueryExtensionCardUserDataSerializedSchemaForApiAddQuickActionResultQuickActionTooltipQueryValidatorWithListVariablesAnyScalarFieldTypeDEFAULT_IFRAME_HEIGHTCollectionEnumFieldTypeKeyDEFAULT_IFRAME_WIDTHBadgePositionsClockwiseFlattenedReferenceKeyNamePatchErrorTooltipFieldFlattenedReferenceKeyIddefaultBadgePositionSerializeddefaultBadgePositionLucid Data APILegacy Data APIRate LimitsGet Rate LimitsgetData SetGet Total Data Sets CountheadGet All Data SetsgetCreate Data SetpostGet Data SetgetUpdate Data Set NamepatchDelete Data SetdeleteData Set GrantGet Data Set GrantgetDelete Data Set GrantdeleteGet All Data Set GrantsgetCreate Data Set GrantpostData Set PropertiesGet Data Set PropertiesgetUpdate Data Set PropertiespatchDelete Data Set PropertiesdeleteData SourceGet Total Data Sources CountheadGet All Data SourcesgetCreate Data SourcepostGet Data SourcegetUpdate Data SourcepatchDelete Data SourcedeleteCreate Data Source from CSVpostUpdate Data Source from CSVputData Source GrantGet Data Source GrantgetDelete Data Source GrantdeleteGet All Data Source GrantsgetCreate Data Source GrantpostCollectionGet Total Collections CountheadGet All CollectionsgetCreate CollectionpostGet CollectiongetUpdate CollectionpatchDelete CollectiondeleteGet All Metadata CollectionsgetCreate Metadata CollectionpostCollection PropertiesGet Collection PropertiesgetUpdate Collection PropertiespatchDelete Collection PropertiesdeleteSchemaGet Field DefinitiongetUpdate Field DefinitionpatchDelete Field DefinitiondeleteGet All Field DefinitionsgetUpdate Field DefinitionspatchDelete Field DefinitionsdeleteData ItemGet Total Data Items CountheadGet All Data ItemsgetCreate Data ItemspostUpdate Data ItemspatchDelete Data ItemsdeleteGet Data ItemgetGet Data Items By KeypostUpdate Data ItempatchDelete Data ItemdeleteUpdate Data Items By KeypatchDelete Data Items By KeydeleteData Item FiltersLucid Legacy APIOther Legacy APIVisioImport Visio FilepostImagesImagesgetValidatorWithMessagetstype ValidatorWithMessage: (x) => true | string; Parameters • x: unknown Returns true | string
