Get Column Custom Field

GET

https://app.schoolset.io/app/api/v2/column/custom/field/:id

GET

/app/api/v2/column/custom/field/:id

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

200Retrieved

1 {
2   "status": "success",
3   "message": "Custom field retrieved successfully.",
4   "data": {
5     "id": 42,
6     "name": "Student Grade",
7     "type": {
8       "fieldType": "dropdown",
9       "validation": "required"
10     },
11     "options": [
12       {
13         "id": 101,
14         "name": "A",
15         "value": "A",
16         "created_by": "admin_user"
17       },
18       {
19         "id": 102,
20         "name": "B",
21         "value": "B",
22         "created_by": "admin_user"
23       },
24       {
25         "id": 103,
26         "name": "C",
27         "value": "C",
28         "created_by": "admin_user"
29       }
30     ],
31     "modules": [
32       {
33         "id": 5,
34         "name": "Grades Module",
35         "sysname": "grades",
36         "slug": "grades-module",
37         "parent_id": null
38       }
39     ],
40     "created_by": "admin_user"
41   }
42 }

Returns custom field information for the selected context.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Success

statusenum

Allowed values:

messagestring

dataobject