---
title: "List document templates"
method: GET
path: "/v1/document-templates"
tags: ["v1 - Document Templates"]
---

# List document templates

`GET /v1/document-templates`

## Request

- Base URL: `https://light.inc` (the document declares no server; this is the origin it was published from)
- URL: `https://light.inc/v1/document-templates`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer

Returns the company's document templates, optionally filtered by document type

## Query parameters

- `companyEntityId` string, uuid
- `sort` string: Sort string in the format `field:direction`. To provide multiple sort fields, separate them with commas. Available directions: `asc`, `desc`. Available fields: `name`, `createdAt`.
- `filter` string: Filter string in the format `field:operator:value`. To provide multiple filters, separate them with commas. Available operators: `eq`, `ne`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`. - For `in` and `not_in` operators, provide multiple values separated by the pipe character (`|`). Available fields: `id`, `name`, `description`, `documentType`, `state`.
- `limit` integer
- `offset` integer

## Response `default`

default response

- ExternalGetAllResponseV1ModelExternalDocumentTemplateV1Model
  - `total` integer
  - `records` ExternalDocumentTemplateV1Model[]
    - `id` string, uuid: Unique identifier for the object
    - `name` string: Name of the template
    - `description` string, nullable: Free-text description of the template
    - `documentType` 'CUSTOMER_CREDIT' | 'INVOICE_PAYABLE_SELF_BILLED' | 'INVOICE_RECEIVABLE' | 'PURCHASE_ORDER': The kind of document the template produces - `CUSTOMER_CREDIT` - Credit note issued to a customer - `INVOICE_PAYABLE_SELF_BILLED` - Self-billed invoice issued on behalf of a vendor - `INVOICE_RECEIVABLE` - Sales invoice issued to a customer - `PURCHASE_ORDER` - Purchase order sent to a vendor ⚠️ This enum is not exhaustive; new values may be added in the future.
    - `companyEntityIds` string[]: IDs of the company entities the template applies to
    - `state` 'ACTIVE' | 'ARCHIVED': Whether the template is active or archived - `ACTIVE` - The template can be assigned to new documents - `ARCHIVED` - The template is archived and can no longer be assigned ⚠️ This enum is not exhaustive; new values may be added in the future.

---

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