List custom fields

GET

https://app.schoolset.io/app/api/v1/custom/fields

Returns all custom field definitions for the current school.

AuthorizationBearer

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

Success

statusenum

Allowed values:

messagestring

datalist of objects

1	{
2	"status": "success",
3	"message": "Custom fields retrieved successfully.",
4	"data": [
5	{
6	"id": 42,
7	"name": "Allergy Information",
8	"model": "Student",
9	"slug": "allergy_info",
10	"type": "text",
11	"visibility": "public",
12	"school_id": 15,
13	"created_by_user_id": 7,
14	"academ_year_id": 2024,
15	"created_at": "2023-08-10T09:15:00Z",
16	"updated_at": "2024-04-20T11:45:00Z"
17	}
18	]
19	}

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