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);
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.layouts({
'page' => 1, # optional
'pageSize' => 10, # optional
'sortBy' => 'createdAt', # optional
'orderBy' => 1 # optional
})
from novu.api import LayoutApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = LayoutApi(url, api_key).list(
page="<Page number for pagination>",
limit="Size of each page",
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.layouts(query = {});
}
}
{
data: ["data"],
page: 0,
pageSize: 0,
totalCount: 0
}
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
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);
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.layouts({
'page' => 1, # optional
'pageSize' => 10, # optional
'sortBy' => 'createdAt', # optional
'orderBy' => 1 # optional
})
from novu.api import LayoutApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = LayoutApi(url, api_key).list(
page="<Page number for pagination>",
limit="Size of each page",
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.layouts(query = {});
}
}
{
data: ["data"],
page: 0,
pageSize: 0,
totalCount: 0
}
Enter your API key in the
Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80eimport { 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);
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.layouts({
'page' => 1, # optional
'pageSize' => 10, # optional
'sortBy' => 'createdAt', # optional
'orderBy' => 1 # optional
})
from novu.api import LayoutApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = LayoutApi(url, api_key).list(
page="<Page number for pagination>",
limit="Size of each page",
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.layouts(query = {});
}
}
{
data: ["data"],
page: 0,
pageSize: 0,
totalCount: 0
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Query Parameters
Number of page for pagination
Required range:
x >= 0Size of page for pagination
Required range:
x >= 0Sort field. Currently only supported createdAt
Direction of the sorting query param
Available options:
ASC, DESC Response
The list of layouts that match the criteria of the query params are successfully returned.
Was this page helpful?