Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Novu Layouts API

Layouts are reusable wrappers for your email notifications.

Novu Layouts API is one of 19 APIs that Novu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 26 JSON Schema definitions.

Tagged areas include Layouts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, a getting-started guide, and 26 JSON Schemas.

This API exposes 8 operations across 5 paths, and defines 31 schemas. It is described by OpenAPI 3.1.0, at version 3.15.0.

Requests are made against 2 base URLs: https://api.novu.co, https://eu.api.novu.co.

8 operations 5 paths 31 schemas 1 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.15.0
Base URL
https://api.novu.co
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Novu Layouts API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (secretKey). By default, every request must be authenticated.

  • secretKey — API key authentication. Allowed headers-- "Authorization: ApiKey ".

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Layouts 8

Layouts are reusable wrappers for your email notifications.

POST
/v2/layouts
Novu Create a Layout
LayoutsController_create body → 201400401403404405409413
GET
/v2/layouts
Novu List All Layouts
LayoutsController_list 5 params → 200400401403404405409413
PUT
/v2/layouts/{layoutId}
Novu Update a Layout
LayoutsController_update 1 param body → 200400401403404405409413
GET
/v2/layouts/{layoutId}
Novu Retrieve a Layout
LayoutsController_get 1 param → 200400401403404405409413
DELETE
/v2/layouts/{layoutId}
Novu Delete a Layout
LayoutsController__delete 1 param → 204400401403404405409413
POST
/v2/layouts/{layoutId}/duplicate
Novu Duplicate a Layout
LayoutsController_duplicate 1 param body → 201400401403404405409413
POST
/v2/layouts/{layoutId}/preview
Novu Generate Layout Preview
LayoutsController_generatePreview 1 param body → 201400401403404405409413
GET
/v2/layouts/{layoutId}/usage
Novu Get Layout Usage
LayoutsController_getUsage 1 param → 200400401403404405409413

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are SubscriberResponseDtoOptional (14 properties), LayoutResponseDto (13 properties), ChannelCredentials (8 properties), ValidationErrorDto (7 properties). Each schema is shown below with its type and property counts.

UiSchema
object
2 properties
ResourceTypeEnum
string
Type of the layout
ChannelSettingsDto
object
4 properties 3 required
UpdateLayoutDto
object
3 properties 1 required
LayoutResponseDto
object
13 properties 11 required
DuplicateLayoutDto
object
3 properties 1 required
LayoutPreviewPayloadDto
object
1 property
ConstraintValidation
object
2 properties 1 required
UserResponseDto
object
4 properties 1 required
EmailControlsDto
object
2 properties 2 required
UiSchemaGroupEnum
string
Group of the UI Schema
ResourceOriginEnum
string
Origin of the layout
EmailLayoutRenderOutput
object
1 property 1 required
ListLayoutResponseDto
object
2 properties 2 required
ErrorDto
object
6 properties 3 required
ValidationErrorDto
object
7 properties 4 required
LayoutResponseDtoSortField
string
GetLayoutUsageResponseDto
object
1 property 1 required
UiSchemaProperty
object
3 properties 1 required
DirectionEnum
string
LayoutCreationSourceEnum
string
Source of layout creation
WorkflowInfoDto
object
2 properties 2 required
LayoutControlsDto
object
3 properties 1 required
LayoutPreviewRequestDto
object
2 properties
GenerateLayoutPreviewResponseDto
object
3 properties 2 required
LayoutControlValuesDto
object
1 property
UiComponentEnum
string
Component type for the UI Schema Property
CreateLayoutDto
object
4 properties 2 required
ChatOrPushProviderEnum
string
The provider identifier for the credentials
ChannelCredentials
object
8 properties
SubscriberResponseDtoOptional
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-layouts-api-openapi.yml Raw ↑

Other APIs Novu publishes across the network.

Novu Inbox / In-App API
Novu Framework (Code-First Workflows)
Novu MCP Server
Novu Activity API
Novu Channel Connections API
Novu Channel Endpoints API
Novu Contexts API
Novu Domains API
Novu Environment Variables API
Novu Environments API
Novu Events API
Novu Integrations API