Layouts
Get layout
API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpsert 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 preferences
- 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
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Layouts
Get layout
Get a layout by its ID
GET
/
v1
/
layouts
/
{layoutId}
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
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"
}
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Response
200
application/json
Ok
The response is of type object
.
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"
}
}