List Column Custom Fields

GET

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

GET

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

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

200Retrieved

1 {
2   "status": "success",
3   "message": "Custom fields retrieved successfully.",
4   "data": [
5     {
6       "id": 101,
7       "name": "Student Allergies",
8       "type": {
9         "field_type": "dropdown",
10         "data_type": "string"
11       },
12       "options": [
13         {
14           "id": 1,
15           "name": "Peanuts",
16           "value": "peanuts",
17           "created_by": "admin_user"
18         },
19         {
20           "id": 2,
21           "name": "Gluten",
22           "value": "gluten",
23           "created_by": "admin_user"
24         },
25         {
26           "id": 3,
27           "name": "None",
28           "value": "none",
29           "created_by": "admin_user"
30         }
31       ],
32       "modules": [
33         {
34           "id": 10,
35           "name": "Student Records",
36           "sysname": "student_records",
37           "slug": "student-records",
38           "parent_id": null
39         }
40       ],
41       "created_by": "admin_user"
42     }
43   ]
44 }

Lists custom fields 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

datalist of objects