Get a PDF template by ID

GET

/document_templates/:document_template_id

Path parameters

document_template_idstringRequired

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

This endpoint returns an object.

idstring

document_typeenum

is_defaultboolean

languagestring

namestring

templatestring

created_atdatetimeOptional

updated_atdatetimeOptional

blockslist of stringsOptional

previewobjectOptional

template_type"block" or "source_object"Optional

Allowed values: blocksource_object

Errors

GET

1 curl https://api.sandbox.monite.com/v1/document_templates/document_template_id \
2      -H "x-monite-version: 2024-01-31" \
3      -H "x-monite-entity-id: x-monite-entity-id" \
4      -H "Authorization: Bearer <token>"

1 {
2   "id": "id",
3   "document_type": "quote",
4   "is_default": true,
5   "language": "language",
6   "name": "name",
7   "template": "template",
8   "created_at": "2024-01-15T09:30:00Z",
9   "updated_at": "2024-01-15T09:30:00Z",
10   "blocks": [
11     "blocks"
12   ],
13   "preview": {
14     "id": "id",
15     "created_at": "2024-01-15T09:30:00Z",
16     "updated_at": "2024-01-15T09:30:00Z",
17     "file_type": "file_type",
18     "md5": "md5",
19     "mimetype": "mimetype",
20     "name": "name",
21     "region": "region",
22     "s3_bucket": "s3_bucket",
23     "s3_file_path": "s3_file_path",
24     "size": 1,
25     "url": "url",
26     "entity_id": "entity_id"
27   },
28   "template_type": "block"
29 }

Set the default PDF template

Up Next

1	curl https://api.sandbox.monite.com/v1/document_templates/document_template_id \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>"

1	{
2	"id": "id",
3	"document_type": "quote",
4	"is_default": true,
5	"language": "language",
6	"name": "name",
7	"template": "template",
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"blocks": [
11	"blocks"
12	],
13	"preview": {
14	"id": "id",
15	"created_at": "2024-01-15T09:30:00Z",
16	"updated_at": "2024-01-15T09:30:00Z",
17	"file_type": "file_type",
18	"md5": "md5",
19	"mimetype": "mimetype",
20	"name": "name",
21	"region": "region",
22	"s3_bucket": "s3_bucket",
23	"s3_file_path": "s3_file_path",
24	"size": 1,
25	"url": "url",
26	"entity_id": "entity_id"
27	},
28	"template_type": "block"
29	}