List all templates

GET

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

GET

/app/api/v1/document-templates/all

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

200Retrieved

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

Returns all document templates with attached file metadata.

Authentication

AuthorizationBearer

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

Response

Successful GET response for /api/v1/document-templates/all.

statusenum

Allowed values:

messagestring

datalist of objects