View a document template

GET

https://ssuccessv2.com/app/api/v1/document-templates/:id

GET

/app/api/v1/document-templates/:id

$ curl https://ssuccessv2.com/app/api/v1/document-templates/42 \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 42,
6     "name": "Emergency Contact Form",
7     "description": "Annual emergency contact information form",
8     "entity_type": "student",
9     "created_at": {},
10     "updated_at": {},
11     "file": {
12       "id": 781,
13       "file_hash": "6d1f4e8a9c2b",
14       "file_name": "emergency-contact-form.pdf",
15       "file_original_name": "Emergency Contact Form.pdf",
16       "file_mime_type": "application/pdf",
17       "caption": "Emergency Contact Form",
18       "file_size": 184320,
19       "created_at": {},
20       "updated_at": {}
21     },
22     "fields": [
23       {
24         "id": 101,
25         "type": "tag",
26         "x": 0.18,
27         "y": 0.32,
28         "width": 0.42,
29         "height": 0.04,
30         "fontSize": 11,
31         "fontFamily": "Arial",
32         "value": null,
33         "page": 1,
34         "merge_tag_id": 27,
35         "merge_tag": null,
36         "created_at": {},
37         "updated_at": {}
38       }
39     ],
40     "field_scan": {
41       "id": 55,
42       "status": "completed",
43       "output": null,
44       "error": null
45     }
46   }
47 }

Returns one document template, its uploaded PDF metadata, configured form fields, and any prefilled-field scan status for the active school.

Authentication

AuthorizationBearer

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

Path parameters

idlongRequired

Document template identifier.

Response

Document template returned.

Errors

401

Unauthorized Error

404

Not Found Error