Factuarea APIDevelopers

List PDF templates

List the PDF templates of your company, paginated by page and per_page (up to 100) and ordered by name, then id. - Filters: q (name), state (active by default, archived or all), document_kind (commercial or transport-document), document_type, purpose and format. - A filter or page value out of range returns 422 instead of being trimmed silently. - Requires pdf_templates:read; employees are not allowed.

GET
/companies/{company}/pdf-templates

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

company*string

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Formatuuid

Query Parameters

q?string

Search by name. Results have a stable order: name, then id, ascending.

Lengthlength <= 120
state?string

Lifecycle filter: active (default), archived or all.

Value in"active" | "archived" | "all"
document_kind?string

Only templates of this kind: commercial or transport-document. Omitted lists every kind.

Value in"commercial" | "transport-document"
document_type?string

Only templates compatible with this document type: invoice, quote, proforma or delivery-note.

Value in"invoice" | "quote" | "proforma" | "delivery-note"
purpose?string

Only templates compatible with this purpose: complete, simplified, corrective or simplified_corrective.

Value in"complete" | "simplified" | "corrective" | "simplified_corrective"
format?string

Only templates compatible with this paper format: a4, ticket_80 or ticket_58.

Value in"a4" | "ticket_80" | "ticket_58"
page?integer

Page number, starting at 1.

Range1 <= value
per_page?integer

Page size, alias of limit (1 to 100, default 25).

Range1 <= value <= 100

Headers

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json