Get built-in PDF templates

GET

/document_templates/system

This API call returns all supported system templates with language codes.

Headers

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Response

Successful Response

datalist of objectsOptional

Errors

GET

1 curl https://api.sandbox.monite.com/v1/document_templates/system \
2      -H "x-monite-version: 2024-05-25" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>"

1 {
2   "data": [
3     {
4       "id": "id",
5       "document_type": "quote",
6       "is_default": true,
7       "language": "language",
8       "name": "name",
9       "template": "template",
10       "created_at": "2024-01-15T09:30:00Z",
11       "updated_at": "2024-01-15T09:30:00Z",
12       "blocks": [
13         "blocks"
14       ],
15       "preview": {
16         "id": "id",
17         "created_at": "2024-01-15T09:30:00Z",
18         "file_type": "payables",
19         "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
20         "mimetype": "application/pdf",
21         "name": "invoice.pdf",
22         "region": "eu-central-1",
23         "size": 24381,
24         "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
25         "pages": [
26           {
27             "id": "id",
28             "mimetype": "image/png",
29             "number": 0,
30             "size": 21972,
31             "url": "https://bucket.s3.amazonaws.com/123/456.png"
32           }
33         ],
34         "previews": [
35           {
36             "height": 400,
37             "url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
38             "width": 200
39           }
40         ]
41       },
42       "template_type": "block"
43     }
44   ]
45 }

Get a PDF template by ID

Up Next

1	curl https://api.sandbox.monite.com/v1/document_templates/system \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>"

1	{
2	"data": [
3	{
4	"id": "id",
5	"document_type": "quote",
6	"is_default": true,
7	"language": "language",
8	"name": "name",
9	"template": "template",
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-01-15T09:30:00Z",
12	"blocks": [
13	"blocks"
14	],
15	"preview": {
16	"id": "id",
17	"created_at": "2024-01-15T09:30:00Z",
18	"file_type": "payables",
19	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
20	"mimetype": "application/pdf",
21	"name": "invoice.pdf",
22	"region": "eu-central-1",
23	"size": 24381,
24	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
25	"pages": [
26	{
27	"id": "id",
28	"mimetype": "image/png",
29	"number": 0,
30	"size": 21972,
31	"url": "https://bucket.s3.amazonaws.com/123/456.png"
32	}
33	],
34	"previews": [
35	{
36	"height": 400,
37	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
38	"width": 200
39	}
40	]
41	},
42	"template_type": "block"
43	}
44	]
45	}