Get template

GET

https://app.schoolset.io/app/api/v1/document-templates/:id

GET

/app/api/v1/document-templates/:id

1 curl https://app.schoolset.io/app/api/v1/document-templates/id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Document template retrieved successfully.",
4   "data": {
5     "id": 42,
6     "name": "Student Enrollment Form",
7     "description": "Template for new student enrollment documents.",
8     "entity_type": "form",
9     "created_at": "2023-11-10T09:15:00Z",
10     "updated_at": "2024-05-20T16:45:00Z",
11     "file": {
12       "fileName": "enrollment_form_v3.pdf",
13       "fileSize": 254000,
14       "fileType": "application/pdf",
15       "url": "https://app.schoolset.io/files/enrollment_form_v3.pdf"
16     },
17     "fields": [
18       {
19         "id": 101,
20         "type": "text",
21         "x": 120.5,
22         "y": 200.75,
23         "width": 300,
24         "height": 25,
25         "fontSize": 12,
26         "fontFamily": "Arial",
27         "value": "Student Full Name",
28         "page": 1,
29         "merge_tag_id": 501,
30         "merge_tag": {
31           "tag": "{{student_full_name}}",
32           "description": "Full name of the student"
33         },
34         "created_at": "2023-11-10T09:15:00Z",
35         "updated_at": "2024-05-20T16:45:00Z"
36       }
37     ]
38   }
39 }

Returns template and related file or field definitions for the requested template ID.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

idstringRequired

Response

Successful GET response for /api/v1/document-templates/{id}.

statusenum

Allowed values:

messagestring

dataobject