List designs
/templates/designsCosts 1 rate-limit point · Rate limits
The app-owned starting designs a new template can be created from (Standard, Classic, Modern and so on): key, name, description and document type. Static; the same for every store. Read-only.
Also searched astemplate designswhich designs can I pickinvoice layoutsdesign galleryavailable template styles
Query parameters
document_typestringOnly designs for this document type.
Returns
itemsarray of objectsShow 4 child attributesHide child attributes
keystringExample:defaultnamestringExample:StandarddescriptionstringExample:Clean, professional invoice with a right-aligned header a…document_typestringExample:invoice
pageobjectOffset paging of a list (
page,per_pagequery params).Show 4 child attributesHide child attributes
numberinteger1-based page number.
sizeintegerRows per page, max 100.
totalintegerRows across all pages.
total_pagesintegerExample:1
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The request failed validation. Nothing was saved.
Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.
Every error has the same shape: see Errors.
curl "https://app.invoicefalcon.com/api/v3/external/templates/designs" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/templates/designs", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/templates/designs",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/templates/designs")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"items": [
{
"key": "default",
"name": "Standard",
"description": "Clean, professional invoice with a right-aligned header and a bordered totals block.",
"document_type": "invoice"
},
{
"key": "classic",
"name": "Classic",
"description": "Traditional, formal layout with detailed sections — ideal for B2B and accounting.",
"document_type": "invoice"
},
{
"key": "modern",
"name": "Modern",
"description": "Bold accent banner header with a colored totals strip for a contemporary look.",
"document_type": "invoice"
}
],
"page": {
"number": 1,
"size": 10,
"total": 10,
"total_pages": 1
}
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}