List statement merge tags

GET

https://ssuccessv2.com/app/api/v2/statement/settings/tags

Lists merge tags enabled for statement-related parent, entity, payment, contract, and family-student contexts. The optional type query selects all, entity, or parent contexts and server permissions and school Jewish-feature settings further filter the collection.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Query parameters

typeenumOptionalDefaults to all

Allowed values:

Response

Filtered merge-tag collection.

statusstring

messagestring

datalist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

1	{
2	"status": "success",
3	"message": "",
4	"data": [
5	{
6	"id": 12,
7	"title": "Student full name",
8	"value": "{{student.full_name}}",
9	"description": "Name shown on the statement",
10	"sys_name": "student_full_name",
11	"slug": "student.full_name",
12	"table_name": "students",
13	"enabled_on": [
14	"parentStudent",
15	"statement"
16	],
17	"is_academic_year": true
18	}
19	]
20	}

$	curl https://ssuccessv2.com/app/api/v2/statement/settings/tags \
>	-H "Authorization: Bearer <token>"