Retrieve the statement email template

GET

https://ssuccessv2.com/app/api/v2/statement/settings/email-template

GET

/app/api/v2/statement/settings/email-template

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

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 7,
6     "subject": {
7       "parent": "Monthly statement for {{student.full_name}}",
8       "entity": "Statement for {{entity.name}}"
9     },
10     "title": {
11       "parent": "Your monthly statement",
12       "entity": "Monthly statement"
13     },
14     "template": {
15       "parent": {
16         "blocks": []
17       },
18       "entity": {
19         "blocks": []
20       }
21     },
22     "template_html": {
23       "parent": [
24         "<p>Your statement is ready.</p>"
25       ],
26       "entity": [
27         "<p>Statement attached.</p>"
28       ]
29     },
30     "direction": {
31       "parent": "ltr",
32       "entity": "ltr"
33     },
34     "created_by": "Avi Cohen",
35     "created_at": {},
36     "updated_at": {}
37   }
38 }

Returns the active school’s persisted statement email template, including parent and entity subject, title, editor payload, rendered HTML chunks, direction, creator, and timestamps. The caller must have view-settings permission.

Authentication

AuthorizationBearer

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

Response

Statement template lookup completed; data is an empty object when no template exists.

statusstring

messagestring

datamap from strings to any

Errors

401

Unauthorized Error

403

Forbidden Error