List the starter library
The starter template library the Templates screen offers: ready-made emails across 14 industries, written by Notix.
https://app.usenotix.dev/api/v1/templates/libraryFull access and read only keys can call this. Sending access keys cannot. Key permissions lists the extra rules some calls have.
The starter template library the Templates screen offers: ready-made emails across 14 industries, written by Notix. Filter by industry, purpose (the kind of email: welcome, codes, receipts, reminders, newsletters and so on), type and query (words in the name, subject, preview line, industry or kind), and page with page and limit (20 a page by default, 60 at most). industries and purposes list every value the filters take, and industryCounts how many entries match in each industry under every filter but industry. previewUrl shows an entry as written, before your brand is applied. Copy one into your templates with POST /v1/templates/from-library.
Who can call it
Full access, read only and live AI keys, limited to one domain or not: the library is Notix's own content, with nothing of your team's in it. Send-only keys answer 403 SCOPE_DENIED. The team can read it 60 times a minute; when Notix cannot count the reads the answer is 503 SERVICE_UNAVAILABLE, never a 429.
Query parameters
Only this industry.
One of ecommerce, fintech, saas, logistics, health, education, fitness, travel, food, events, property, agency, media, nonprofit.
Only this kind of email (the library screen's category).
One of onboard, verify, receipt, status, remind, recover, announce, promote, event, feedback.
Only TRANSACTIONAL or only MARKETING entries.
One of TRANSACTIONAL, MARKETING.
Words to find in an entry's name, subject, preview line, industry or kind.
Page number, from 1.
Minimum 1. Maximum 100.
Entries per page, 20 by default, 60 at most.
Minimum 1. Maximum 60.
Headers
Bearer followed by your API key.
Errors
A filter that is not one of the listed values, or a query parameter the route does not know.
`SCOPE_DENIED`: a send-only key.
The team read the library 60 times in the last minute.
Notix cannot count the team's calls just now; try again shortly.
Every error has the same shape. See all error codes.
curl -X GET "https://app.usenotix.dev/api/v1/templates/library" \
-H "Authorization: Bearer $NOTIX_API_KEY"
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.templates.library({ industry: "saas", purpose: "onboard" });
console.log(data?.data.map((entry) => entry.id));
{
"data": [
{
"id": "saas-welcome-setup",
"name": "Welcome",
"subject": "Your receipt for order 4471",
"previewText": "Thanks for your order.",
"type": "TRANSACTIONAL",
"industry": "saas",
"industryLabel": "SaaS & software",
"purpose": "onboard",
"purposeLabel": "Welcome",
"previewUrl": "string"
}
],
"page": 1,
"limit": 1,
"total": 1,
"hasMore": true,
"industryCounts": {},
"industries": [
{
"key": "string",
"label": "string"
}
],
"purposes": [
{
"key": "string",
"label": "string"
}
]
}