Get a form

GET

https://ssuccessv2.com/app/api/v1/forms/:form

GET

/app/api/v1/forms/:form

$ curl https://ssuccessv2.com/app/api/v1/forms/42 \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 42,
6     "name": "2026-2027 Enrollment Form",
7     "academic_year_id": 7,
8     "submissions_count": 18,
9     "active": true,
10     "data_schema": {
11       "type": "object",
12       "properties": {
13         "student_name": {
14           "type": "string"
15         }
16       }
17     },
18     "ui_schema": [
19       {
20         "key": "student_name",
21         "type": "text"
22       }
23     ],
24     "form_audience_id": 1,
25     "thank_you_message": "Thanks for submitting your enrollment form.",
26     "recaptcha": true,
27     "email_receipt": true,
28     "payment_settings": {},
29     "coupon_usage": {
30       "SPRING10": 3
31     },
32     "payment_option_inventory": {},
33     "thank_you_icon": "check",
34     "thank_you_icon_color": "#2E7D32"
35   }
36 }

Returns the complete form definition, schemas, payment settings, coupon usage, and non-spam submission count for the active school.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

formlongRequired

Response

Form details in the standard SchoolSet success envelope.

statusstring

messagestring

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error