Custom Field

A custom field defines an abstract field that admissions staff can use to store arbitrary data about an applicant. The data itself is stored in a custom field answer.


Name Type Description Example
custom_fields/field_type string The type of data that this field stores.
one of:"boolean" or "number" or "date" or "string" or "select"
custom_fields/id integer Unique identifier for this custom field. 4
custom_fields/label string Human-readable name of this custom field. "Preferred house"
custom_fields/options nullable array When field_type is "select", this defines the list of allowed values for the field. Otherwise, this is null. ["Gryffindor","Hufflepuff","Ravenclaw","Slytherin"]
href string Hypertext reference to this resource.
pattern: /api/v1/user_identities/\d+/programs/\d+/custom_fields

Custom Field List

List existing custom fields.

GET /api/v1/user_identities/:user_identity_id/programs/:program_id/custom_fields

Curl Example

$ curl -n \
  -H "x-api-key: 0123456789abcdef0123456789abcdef"

Response Example

HTTP/1.1 200 OK
  "href": "/api/v1/user_identities/1/programs/42023191739237/custom_fields",
  "custom_fields": [
      "id": 4,
      "label": "Preferred house",
      "field_type": "select",
      "options": [

Not Found

Response Example

HTTP/1.1 404 Not Found
  "message": "Not Found"

While 404 Not Found is most often associated with resources that don't exist when making a GET request, please note that 404 Not Found is also the response during POST, PUT, and PATCH requests if any resources specified by parameters cannot be found.


Response Example

HTTP/1.1 401 Unauthorized

(Empty response body.)