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

​
Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Path Parameters

​
layoutId
string
required

Response

200
application/json
Ok
​
_organizationId
string
required
​
_environmentId
string
required
​
_creatorId
string
required
​
name
string
required
​
identifier
string
required
​
channel
enum<string>
required
Available options:
in_app,
email,
sms,
chat,
push
​
content
string
required
​
contentType
string
required
​
isDefault
boolean
required
​
isDeleted
boolean
required
​
_id
string
​
description
string
​
variables
object[]
​
createdAt
string
​
updatedAt
string
​
_parentId
string

Was this page helpful?