Layouts

Retrieve a layout

Fetches details of a specific layout by its unique identifier layoutId

get/v2/layouts/{layoutId}

Path parameters

layoutIdstring required

idempotency-keystring

A header for idempotency purposes

_idstring required

Unique internal identifier of the layout

layoutIdstring required

Unique identifier for the layout

slugstring required

Slug of the layout

namestring required

Name of the layout

isDefaultboolean required

Whether the layout is the default layout

isTranslationEnabledboolean required

Whether the layout translations are enabled

updatedAtstring required

Last updated timestamp

createdAtstring required

Creation timestamp

origin'novu-cloud' | 'novu-cloud-v1' | 'external' required

Origin of the layout

type'REGULAR' | 'ECHO' | 'BRIDGE' required

Type of the layout

variablesobject nullable

The variables JSON Schema for the layout

Changed in 2 of the 12 revisions of this API.3

Aug 16, 2026c2b2fa0d5d481See the full diff
- ●
  added the new CHAT_EDITOR_SELECT enum value to the controls/allOf[LayoutControlsDto]/uiSchema/allOf[UiSchema]/properties/additionalProperties/component response property for the response status 200
  response-property-enum-value-added
Jul 21, 2026c69777f601842See the full diff
- ●
  added the new TOOL enum value to the controls/allOf[LayoutControlsDto]/uiSchema/allOf[UiSchema]/group response property for the response status 200
  response-property-enum-value-added
- ●
  added the new TOOL_BODY enum value to the controls/allOf[LayoutControlsDto]/uiSchema/allOf[UiSchema]/properties/additionalProperties/component response property for the response status 200
  response-property-enum-value-added