Download Parents XLS

GET

https://app.schoolset.io/app/api/v1/parents/download/xls

GET

/app/api/v1/parents/download/xls

1 curl https://app.schoolset.io/app/api/v1/parents/download/xls \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Parent records XLS export generated successfully.",
4   "data": {
5     "id": 1024,
6     "name": "parents_export_2024_06_01.xlsx",
7     "original_name": "Parents_List_June_2024.xlsx",
8     "mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
9     "academ_year_id": 2024,
10     "school_id": 58,
11     "created_by_user_id": 12,
12     "path_dir": "/exports/parents/2024/06",
13     "path_file": "/exports/parents/2024/06/parents_export_2024_06_01.xlsx",
14     "hash": "a3f5c9d8e7b4f1a2c6d3e8b9f0a1c2d3",
15     "deleted_at": null,
16     "created_at": "2024-06-01T09:15:00Z",
17     "updated_at": "2024-06-01T09:15:00Z"
18   }
19 }

Lists parent records for the active school context.

Authentication

AuthorizationBearer

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

Response

JSON response payload for parent XLS export file.

statusenum

Allowed values:

messagestring

dataobject