List Custom Fields Data

GET

https://app.schoolset.io/app/api/v2/column/custom/fields/data

GET

/app/api/v2/column/custom/fields/data

1 curl https://app.schoolset.io/app/api/v2/column/custom/fields/data \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Custom fields data retrieved successfully.",
4   "data": {
5     "columns": [
6       {
7         "id": 101,
8         "name": "Student Grade",
9         "type": {
10           "fieldType": "dropdown",
11           "dataType": "string"
12         },
13         "options": [
14           {
15             "id": 1,
16             "name": "A",
17             "value": "A",
18             "created_by": "admin_user"
19           },
20           {
21             "id": 2,
22             "name": "B",
23             "value": "B",
24             "created_by": "admin_user"
25           },
26           {
27             "id": 3,
28             "name": "C",
29             "value": "C",
30             "created_by": "admin_user"
31           }
32         ],
33         "modules": [
34           {
35             "id": 10,
36             "name": "Student Records",
37             "sysname": "student_records",
38             "slug": "student-records",
39             "parent_id": null
40           }
41         ],
42         "created_by": "admin_user"
43       }
44     ],
45     "data": [
46       {
47         "student_id": 5001,
48         "Student Grade": "A"
49       },
50       {
51         "student_id": 5002,
52         "Student Grade": "B"
53       }
54     ]
55   }
56 }

Lists fields data records for the active school context.

Authentication

AuthorizationBearer

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

Response

Success

statusenum

Allowed values:

messagestring

dataobject