Get Registration Year Settings

GET

https://app.schoolset.io/app/api/v2/registration/year/settings/:year_id

GET

/app/api/v2/registration/year/settings/:year_id

1 curl https://app.schoolset.io/app/api/v2/registration/year/settings/year_id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Registration settings retrieved successfully.",
4   "data": {
5     "registration_opens": "2024-08-01T08:00:00Z",
6     "registration_closes": "2024-09-15T23:59:59Z",
7     "start_at": "2024-09-01T09:00:00Z",
8     "end_at": "2025-06-30T15:00:00Z",
9     "title": "2024-2025 Academic Year Registration",
10     "early_bird_ends": "2024-08-15T23:59:59Z",
11     "early_bird_discount": 10,
12     "early_bird_discount_type": "percentage",
13     "registration_steps": [
14       "Submit application",
15       "Upload documents",
16       "Pay fees",
17       "Confirm enrollment"
18     ]
19   }
20 }

Returns registration information for the selected context.

Authentication

AuthorizationBearer

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

Path parameters

year_idstringRequired

Response

Success

statusenum

Allowed values:

messagestring

dataobject