Get templates by entity type

POST

https://app.schoolset.io/app/api/v1/document-templates/get-for-entity-type

POST

/app/api/v1/document-templates/get-for-entity-type

1 curl -X POST https://app.schoolset.io/app/api/v1/document-templates/get-for-entity-type \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "entity_type": "student"
6 }'

200Successful

1 {
2   "status": "success",
3   "message": "Templates retrieved successfully for entity type 'student'.",
4   "data": [
5     {
6       "id": 101,
7       "name": "Student Enrollment Form",
8       "description": "Template for new student enrollment documentation.",
9       "entity_type": "student",
10       "created_at": "2023-11-01T09:15:00Z",
11       "updated_at": "2024-04-20T14:45:00Z",
12       "file": {},
13       "fields": [
14         {
15           "id": 501,
16           "type": "text",
17           "x": 50.5,
18           "y": 120.75,
19           "width": 200,
20           "height": 25,
21           "fontSize": 12,
22           "fontFamily": "Arial",
23           "value": "Student Name",
24           "page": 1,
25           "merge_tag_id": 301,
26           "merge_tag": {},
27           "created_at": "2023-11-01T09:15:00Z",
28           "updated_at": "2024-04-20T14:45:00Z"
29         }
30       ]
31     }
32   ]
33 }

Returns templates available for a requested entity type.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

entity_typeenumRequired

Entity type to filter templates.

Allowed values:

Response

Successful POST response for /api/v1/document-templates/get-for-entity-type.

statusenum

Allowed values:

messagestring

datalist of objects