List family attachments

GET

https://ssuccessv2.com/app/api/v1/family/:id/attachments

GET

/app/api/v1/family/:id/attachments

$ curl https://ssuccessv2.com/app/api/v1/family/1842/attachments \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 9021,
7       "file_name": "immunization-record.pdf",
8       "file_original_name": "Mateo immunization record.pdf",
9       "file_mime_type": "application/pdf",
10       "url": "https://files.example.com/signed/9021",
11       "related_to": "Mateo Garcia",
12       "caption": "Immunization record",
13       "file_size": 184320,
14       "scan_id": "clean",
15       "upload_status": "uploaded",
16       "created_by": "Office Admin",
17       "created_at": "2024-01-15T09:30:00Z",
18       "updated_at": "2024-01-15T09:30:00Z",
19       "model_name": "Student",
20       "model_id": 2987,
21       "file_category": null
22     }
23   ]
24 }

Lists files attached to the family, its parents, and its students, newest first. File URLs may be temporary signed URLs.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired>=1

Response

Attachments returned.

statusstring

messagestring

datalist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error