Get merge tags by entity type

POST

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

POST

/app/api/v1/document-templates/tags

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

200Successful

1 {
2   "status": "success",
3   "message": "Merge tags retrieved successfully for the student entity.",
4   "data": [
5     {
6       "id": 101,
7       "title": "Student Full Name",
8       "value": "{{student.full_name}}",
9       "description": "The full name of the student as recorded in the system.",
10       "sys_name": "student_full_name",
11       "slug": "student-full-name",
12       "table_name": "students",
13       "enabled_on": [
14         "enrollment_letter",
15         "report_card",
16         "certificate"
17       ],
18       "is_academic_year": false
19     }
20   ]
21 }

Returns merge tags available for a given document template entity type.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

tagsForenumRequired

Entity type to scope merge-tag results.

Response

Successful POST response for /api/v1/document-templates/tags.

statusenum

Allowed values:

messagestring

datalist of objects