Get Column Custom Field

GET

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

GET

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

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

200Retrieved

1 {
2   "status": "success",
3   "message": "Field attach information retrieved successfully.",
4   "data": {
5     "id": 42,
6     "name": "Student Enrollment Status",
7     "type": {
8       "fieldType": "dropdown",
9       "required": true
10     },
11     "options": [
12       {
13         "id": 101,
14         "name": "Enrolled",
15         "value": "enrolled",
16         "created_by": "admin_user"
17       },
18       {
19         "id": 102,
20         "name": "Pending",
21         "value": "pending",
22         "created_by": "admin_user"
23       },
24       {
25         "id": 103,
26         "name": "Withdrawn",
27         "value": "withdrawn",
28         "created_by": "admin_user"
29       }
30     ],
31     "modules": [
32       {
33         "id": 5,
34         "name": "Student Management",
35         "sysname": "student_mgmt",
36         "slug": "student-management",
37         "parent_id": null
38       }
39     ],
40     "created_by": "system_admin"
41   }
42 }

Returns field attach 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