> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.schoolset.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server.

# Get a form

GET https://ssuccessv2.com/app/api/v1/forms/{form}

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

Reference: https://docs.schoolset.io/api-reference/school-set-api/forms/get-form

## Authentication

- `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend.

## Request

### Path parameters

- `form` (long, required)

## Response

### 200

Form details in the standard SchoolSet success envelope.

- `status` (string, required)
- `message` (string, required)
- `data` (ApiV1FormsFormGetResponsesContentApplicationJsonSchemaData, required)

## Errors

### 401 Unauthorized Error

Authentication is required

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 403 Forbidden Error

Caller lacks view-forms permission

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 404 Not Found Error

Form was not found

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

## Types

### ApiV1FormsFormGetResponsesContentApplicationJsonSchemaData

- `id` (integer, required)
- `name` (string, required)
- `academic_year_id` (integer, required)
- `submissions_count` (integer, required)
- `active` (boolean, required)
- `data_schema` (map from string to any, required)
- `ui_schema` (list of map from string to any, required)
- `form_audience_id` (integer, optional, nullable)
- `thank_you_message` (string, optional, nullable)
- `recaptcha` (boolean, optional)
- `email_receipt` (boolean, optional)
- `payment_settings` (map from string to any, optional, nullable)
- `coupon_usage` (map from string to any, optional)
- `payment_option_inventory` (map from string to any, optional)
- `thank_you_icon` (string, optional, nullable)
- `thank_you_icon_color` (string, optional, nullable)

## Examples

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": {
    "id": 42,
    "name": "2026-2027 Enrollment Form",
    "academic_year_id": 7,
    "submissions_count": 18,
    "active": true,
    "data_schema": {
      "type": "object",
      "properties": {
        "student_name": {
          "type": "string"
        }
      }
    },
    "ui_schema": [
      {
        "key": "student_name",
        "type": "text"
      }
    ],
    "form_audience_id": 1,
    "thank_you_message": "Thanks for submitting your enrollment form.",
    "recaptcha": true,
    "email_receipt": true,
    "payment_settings": {},
    "coupon_usage": {
      "SPRING10": 3
    },
    "payment_option_inventory": {},
    "thank_you_icon": "check",
    "thank_you_icon_color": "#2E7D32"
  }
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v1/forms/42"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v1/forms/42';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v1/forms/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/forms/42")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://ssuccessv2.com/app/api/v1/forms/42")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://ssuccessv2.com/app/api/v1/forms/42', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/forms/42");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/forms/42")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```