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

# GetCustomFields

GET https://dreamclassapi/v1/students/custom-fields

Get a list of the available custom fields for students

Reference: https://apidoc.dreamclass.io/dream-class-api/students/get-custom-fields

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /dreamclassapi/v1/students/custom-fields:
    get:
      operationId: get-custom-fields
      summary: GetCustomFields
      description: Get a list of the available custom fields for students
      tags:
        - subpackage_students
      parameters:
        - name: tenant
          in: header
          required: false
          schema:
            type: string
        - name: schoolCode
          in: header
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItems
servers:
  - url: https:/
    description: https://{server}
  - url: https://your-webhook-url
    description: https://your-webhook-url
components:
  schemas:
    DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItemsFormFieldSelectOptions:
      type: object
      properties: {}
      title: >-
        DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItemsFormFieldSelectOptions
    DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItemsFormField:
      type: object
      properties:
        row:
          type: string
        type:
          type: string
        label:
          type: string
        selectOptions:
          $ref: >-
            #/components/schemas/DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItemsFormFieldSelectOptions
        hiddenToStudents:
          type: boolean
        hiddenToTeachers:
          type: boolean
        hiddenToGuardians:
          type: boolean
        editableByStudents:
          type: boolean
        editableByTeachers:
          type: boolean
        editableByGuardians:
          type: boolean
      required:
        - row
        - type
        - label
        - selectOptions
        - hiddenToStudents
        - hiddenToTeachers
        - hiddenToGuardians
        - editableByStudents
        - editableByTeachers
        - editableByGuardians
      title: >-
        DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItemsFormField
    DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItemsInstitution:
      type: object
      properties:
        id:
          type: integer
      required:
        - id
      title: >-
        DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItemsInstitution
    DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        id:
          type: integer
        formField:
          $ref: >-
            #/components/schemas/DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItemsFormField
        entityType:
          type: string
        institution:
          $ref: >-
            #/components/schemas/DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItemsInstitution
      required:
        - id
        - formField
        - entityType
        - institution
      title: >-
        DreamclassapiV1StudentsCustomFieldsGetResponsesContentApplicationJsonSchemaItems

```

## Examples



**Request**

```json
{}
```

**Response**

```json
[
  {
    "id": 15,
    "formField": {
      "row": "1",
      "type": "text",
      "label": "Passport Number",
      "selectOptions": {},
      "hiddenToStudents": false,
      "hiddenToTeachers": false,
      "hiddenToGuardians": false,
      "editableByStudents": true,
      "editableByTeachers": true,
      "editableByGuardians": true
    },
    "entityType": "STUDENT",
    "institution": {
      "id": 42
    }
  },
  {
    "id": 202,
    "formField": {
      "row": "2",
      "type": "custom-field-select",
      "label": "Enrollment Type",
      "selectOptions": {
        "options": [
          {
            "name": "Full time"
          },
          {
            "name": "Part time"
          },
          {
            "name": "Exchange"
          }
        ]
      },
      "hiddenToStudents": false,
      "hiddenToTeachers": false,
      "hiddenToGuardians": false,
      "editableByStudents": true,
      "editableByTeachers": true,
      "editableByGuardians": true
    },
    "entityType": "STUDENT",
    "institution": {
      "id": 42
    }
  }
]
```

**SDK Code**

```python Students_GetCustomFields_example
import requests

url = "https://https/dreamclassapi/v1/students/custom-fields"

payload = {}
headers = {
    "tenant": "{{tenant}}",
    "schoolCode": "{{schoolCode}}",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Students_GetCustomFields_example
const url = 'https://https/dreamclassapi/v1/students/custom-fields';
const options = {
  method: 'GET',
  headers: {
    tenant: '{{tenant}}',
    schoolCode: '{{schoolCode}}',
    'Content-Type': 'application/json'
  },
  body: '{}'
};

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

```go Students_GetCustomFields_example
package main

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

func main() {

	url := "https://https/dreamclassapi/v1/students/custom-fields"

	payload := strings.NewReader("{}")

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

	req.Header.Add("tenant", "{{tenant}}")
	req.Header.Add("schoolCode", "{{schoolCode}}")
	req.Header.Add("Content-Type", "application/json")

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

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

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

}
```

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

url = URI("https://https/dreamclassapi/v1/students/custom-fields")

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

request = Net::HTTP::Get.new(url)
request["tenant"] = '{{tenant}}'
request["schoolCode"] = '{{schoolCode}}'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

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

HttpResponse<String> response = Unirest.get("https://https/dreamclassapi/v1/students/custom-fields")
  .header("tenant", "{{tenant}}")
  .header("schoolCode", "{{schoolCode}}")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://https/dreamclassapi/v1/students/custom-fields', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'schoolCode' => '{{schoolCode}}',
    'tenant' => '{{tenant}}',
  ],
]);

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

```csharp Students_GetCustomFields_example
using RestSharp;

var client = new RestClient("https://https/dreamclassapi/v1/students/custom-fields");
var request = new RestRequest(Method.GET);
request.AddHeader("tenant", "{{tenant}}");
request.AddHeader("schoolCode", "{{schoolCode}}");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Students_GetCustomFields_example
import Foundation

let headers = [
  "tenant": "{{tenant}}",
  "schoolCode": "{{schoolCode}}",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://https/dreamclassapi/v1/students/custom-fields")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```