Skip to content

List designs

GET/templates/designs

Costs 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_typestring

    Only designs for this document type.

Returns

  • itemsarray of objects
    Show 4 child attributesHide child attributes
    • keystring
      Example: default
    • namestring
      Example: Standard
    • descriptionstring
      Example: Clean, professional invoice with a right-aligned header a…
    • document_typestring
      Example: invoice
  • pageobject

    Offset paging of a list (page, per_page query params).

    Show 4 child attributesHide child attributes
    • numberinteger

      1-based page number.

    • sizeinteger

      Rows per page, max 100.

    • totalinteger

      Rows across all pages.

    • total_pagesinteger
      Example: 1

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

422

The request failed validation. Nothing was saved.

429

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.

GET/templates/designs
curl "https://app.invoicefalcon.com/api/v3/external/templates/designs" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "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
  }
}