Layouts
Filter layouts
Layouts
Filter layouts
Returns a list of layouts that can be paginated using the page query parameter and filtered by the environment where it is executed from the organization the user belongs to.
GET
/
v1
/
layouts
Authorization
Query
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>');
const params = {
page: 0, // optional
pageSize: 20, // optional
sortBy: "_id"
orderBy: -1 //optional
}
await novu.layouts.list(params);
{
data: ["data"],
page: 0,
pageSize: 0,
totalCount: 0
}
Authorizations
Authorizationheaderrequired
string
Query Parameters
page
number
Number of page for the pagination
pageSize
number
Size of page for the pagination
sortBy
string
Sort field. Currently only supported createdAt
orderBy
enum<number>
Direction of the sorting query param. Either ascending (1) or descending (-1)
Available options:
1, -1 Response
200 - application/json
datarequired
object[]
pagerequired
number
pageSizerequired
number
totalCountrequired
number
Was this page helpful?
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
const params = {
page: 0, // optional
pageSize: 20, // optional
sortBy: "_id"
orderBy: -1 //optional
}
await novu.layouts.list(params);
{
data: ["data"],
page: 0,
pageSize: 0,
totalCount: 0
}