Get custom field

GET

https://app.schoolset.io/app/api/v1/custom/field/:id

Returns the selected custom field definition.

AuthorizationBearer

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

idstringRequired

Success

statusenum

Allowed values:

messagestring

dataobject

1	{
2	"status": "success",
3	"message": "Custom field retrieved successfully.",
4	"data": {
5	"id": 42,
6	"name": "Student Allergies",
7	"model": "StudentProfile",
8	"slug": "student_allergies",
9	"type": "text",
10	"visibility": "public",
11	"school_id": 15,
12	"created_by_user_id": 7,
13	"academ_year_id": 2023,
14	"created_at": "2023-08-01T09:15:00Z",
15	"updated_at": "2024-04-10T11:45:00Z"
16	}
17	}

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