> 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 form field mappings

GET https://ssuccessv2.com/app/api/v1/forms/{id}/field-mappings

Returns the saved mappings for a form together with the visible system fields grouped by record type.

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

## Authentication

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

## Request

### Path parameters

- `id` (integer, required)

## Response

### 200

Mappings and importable system fields.

- `status` (string, required)
- `message` (string, required)
- `data` (ApiV1FormsIdFieldMappingsGetResponsesContentApplicationJsonSchemaData, 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

### ApiV1FormsIdFieldMappingsGetResponsesContentApplicationJsonSchemaData

- `mappings` (list of ApiV1FormsIdFieldMappingsGetResponsesContentApplicationJsonSchemaDataMappingsItems, optional)
- `system_fields` (map from string to list of ApiV1FormsIdFieldMappingsGetResponsesContentApplicationJsonSchemaDataSystemFieldsItems, optional)

### ApiV1FormsIdFieldMappingsGetResponsesContentApplicationJsonSchemaDataMappingsItems

- `id` (integer, required)
- `form_field_name` (string, required)
- `system_field_name` (string, required)
- `record_type` (string, required)

### ApiV1FormsIdFieldMappingsGetResponsesContentApplicationJsonSchemaDataSystemFieldsItems

- `name` (string, required)
- `label` (string, required)
- `required` (boolean, required)

## Examples

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": {
    "mappings": [
      {
        "id": 11,
        "form_field_name": "student_name",
        "system_field_name": "first_name",
        "record_type": "student"
      }
    ],
    "system_fields": {
      "student": [
        {
          "name": "first_name",
          "label": "First name",
          "required": true
        }
      ]
    }
  }
}
```

**SDK Code**

```python
import requests

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

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

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

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v1/forms/42/field-mappings';
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/field-mappings"

	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/field-mappings")

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/field-mappings")
  .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/field-mappings', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/forms/42/field-mappings");
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/field-mappings")! 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()
```