- API Reference
- Discord Support
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate subscriber credentials
- DELDelete subscriber credentials by providerid
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preference
- GETGet in app notification feed for a particular subscriber
- GETGet the unseen in app notifications count for subscribers feed
- POSTMark a subscriber feed message as seen
- POSTMarks all the subscriber messages as read unread seen or unseen optionally you can pass feed id or array to mark messages of a particular feed
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
- GETFilter topics
- POSTTopic creation
- POSTSubscribers addition
- GETCheck topic subscriber
- POSTSubscribers removal
- GETGet topic
- DELDelete topic
- PATCHRename a topic
- GETGet notifications
- GETGet notification statistics
- GETGet notification graph statistics
- GETGet notification
- GETGet workflows
- POSTCreate workflow
- GETGet workflow
- PUTUpdate workflow
- DELDelete workflow
- PUTUpdate workflow status
- POSTCreate workflow overrides
- GETGet workflow overrides
- GETGet workflow override
- GETGet workflow override by id
- PUTUpdate workflow override by id
- PUTUpdate workflow override
- DELDelete workflow override
- GETGet workflow groups
- POSTCreate workflow group
- GETGet workflow group
- DELDelete workflow group
- PATCHUpdate workflow group
- GETGet integrations
- POSTCreate integration
- GETGet active integrations
- GETGet webhook support status for provider
- PUTUpdate integration
- DELDelete integration
- POSTSet integration as primary
- GETFilter layouts
- POSTLayout creation
- GETGet layout
- DELDelete layout
- PATCHUpdate a layout
- POSTSet default layout
- GETGet execution details
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Layouts
Get layout
GET
/
v1
/
layouts
/
{layoutId}
Authorization
string
*
Authorization
Required
string
layoutId
string
*
layoutId
Required
string
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.layouts.get("layoutId");
{
"data": {
"_id": "string",
"_organizationId": "string",
"_environmentId": "string",
"_creatorId": "string",
"name": "string",
"identifier": "string",
"description": "string",
"channel": "in_app",
"content": "string",
"contentType": "string",
"variables": [
{}
],
"isDefault": true,
"isDeleted": true,
"createdAt": "string",
"updatedAt": "string",
"_parentId": "string"
}
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Path Parameters
layoutId
string
requiredResponse
200 - application/json
data
object
data._id
string
data._organizationId
string
requireddata._environmentId
string
requireddata._creatorId
string
requireddata.name
string
requireddata.identifier
string
requireddata.description
string
data.channel
enum<string>
requiredAvailable options:
in_app
, email
, sms
, chat
, push
data.content
string
requireddata.contentType
string
requireddata.variables
object[]
data.isDefault
boolean
requireddata.isDeleted
boolean
requireddata.createdAt
string
data.updatedAt
string
data._parentId
string
Was this page helpful?
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.layouts.get("layoutId");
{
"data": {
"_id": "string",
"_organizationId": "string",
"_environmentId": "string",
"_creatorId": "string",
"name": "string",
"identifier": "string",
"description": "string",
"channel": "in_app",
"content": "string",
"contentType": "string",
"variables": [
{}
],
"isDefault": true,
"isDeleted": true,
"createdAt": "string",
"updatedAt": "string",
"_parentId": "string"
}
}