---
title: "List Layouts"
method: GET
path: "/v2/invoice-pdf-templates/layouts"
tags: ["invoice-pdf-templates"]
---

# List Layouts

`GET /v2/invoice-pdf-templates/layouts`

## Request

- Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.stuut.ai/v2/invoice-pdf-templates/layouts`
- Auth: HTTP bearer

List Invoice PDF Layouts

Shared designs, then any built for this organization. `layout_name` must be one of these.

## Response `200`

Successful Response

- InvoicePdfLayoutOption[]
  - `name` string, required
  - `label` string, required
  - `description` string, required
  - `is_org_layout` boolean, required
  - `orientation` 'portrait' | 'landscape', required
  - `regions` InvoicePdfLayoutRegion[], required
    - `region` string, required
    - `elements` InvoicePdfLayoutElement[], required
      - `id` string, required
      - `kind` 'logo' | 'title' | 'lines' | 'kv' | 'summary' | 'table' | 'totals' | 'text' | 'column', required: The shape the dashboard's sketch of the page draws for the element. `column` is set by the layout, not listed in `ELEMENTS`: an element it marks on a `<th>` prints as one column of a strip, with its value underneath.
      - `label` string, required
      - `toggle` string, nullable, required
  - `default_labels` object, required

---

[API](https://skmtc.dev/stuut/apis/stuut-api.md) - [All operations](https://skmtc.dev/stuut/apis/stuut-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stuut/apis/stuut-api/revisions/ff0ad16a55ff?raw)