GET
/
v1
/
layouts
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
}

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

​
Authorization
string
header
required

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

Query Parameters

​
page
number

Number of page for pagination

Required range: x >= 0
​
pageSize
number

Size of page for pagination

Required range: x >= 0
​
sortBy
string

Sort field. Currently only supported createdAt

​
orderBy
enum<string>

Direction of the sorting query param

Available options:
ASC,
DESC

Response

200
_mintlify/placeholder

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

Was this page helpful?

Set integration as primaryLayout creation