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.

Node.js

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);

Response

{
    data: ["data"],
    page: 0,
    pageSize: 0,
    totalCount: 0
}

Query Parameters

page · number

Number of page for the pagination

Required range: x >= 0

pageSize · number

Size of page for the pagination

Required range: x >= 0

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

The list of layouts that match the criteria of the query params are successfully returned.

data · object[] · required

Show child attributes

page · number · required

pageSize · number · required

totalCount · number · required