Get an action

GET

Path parameters

actionIdstringRequired

The id of the action to return

Headers

X-Disable-Hooks"true"Required

Response

This endpoint returns an object.
createdAtdatetime
idstring

Action ID

labelstring

The text on the Button itself

targetIdstring
updatedAtdatetime
confirmbooleanOptional

Whether to show a modal to confirm the action

constraintslist of objectsOptional

A limitation or restriction on the action.

descriptionstringOptional

The text that appears in the dialog after the action is clicked.

guardrailobjectOptional
guideobjectOptional
iconstringOptional

Icon will work on primary actions. It will only accept an already existing Flatfile design system icon.

inputFormobjectOptional

Adds an input form for this action after it is clicked.

messageslist of objectsOptional
modeenumOptional
Allowed values: foregroundbackgroundtoolbarBlocking

Foreground and toolbarBlocking action mode will prevent interacting with the resource until complete

mountobjectOptional
operationstringOptional

This will become the job operation that is triggered

primarybooleanOptional

A primary action will be more visibly present, whether in Sheet or Workbook.

scheduleenumOptional
Allowed values: weeklydailyhourly

Determines if the action should happen on a regular cadence.

tooltipstringOptional

A tooltip that appears when hovering the action button

typestringOptional

This is deprecated.

requireAllValidbooleanOptionalDeprecated

This is deprecated. Use constraints instead.

requireSelectionbooleanOptionalDeprecated

This is deprecated. Use constraints instead.

slugstringOptionalDeprecated

This is deprecated. Use operation instead.

Built with