query · Module: Templates · Requires templates:read
Arguments
| Argument | Type | Description |
|---|---|---|
type | String | Filter by type. |
relatedObject | String | Filter by related object. |
status | String | Filter by status. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
Returns
DocumentTemplateList!
| Field | Type |
|---|---|
data | [DocumentTemplate!]! |
has_more | Boolean |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query DocumentTemplates($limit: Int) {
documentTemplates(limit: $limit) {
data {
id
object
name
type
status
livemode
created
updated
slug
version
related_object
engine
source
page {
size
orientation
margins_mm
dpi
}
formats
locale
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"documentTemplates": {
"data": [
{
"id": "dtpl_1a2B3c",
"object": "document_template",
"name": "Example",
"type": "example",
"status": "draft",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"slug": "example",
"version": 3,
"related_object": "shipment",
"engine": "liquid",
"source": "api",
"page": {
"size": "4x6",
"orientation": "portrait",
"margins_mm": 1.5,
"dpi": 2
},
"formats": [
"pdf"
],
"locale": "example"
}
],
"has_more": true
}
}
}