Get profile schema

Returns the complete field schema for candidate profiles in your institution. The response lists every available field, organised into sections, with its name, label, type, and whether it is required. Use this before creating or updating profiles to understand which fields are available and how values should be formatted.

Responses

application/json
application/json
application/json

get/apis/profiles/schema

curl https://ff-business-school.fullfabric.cloud/apis/profiles/schema \
  --header 'FF-Auth: YOUR_SECRET_TOKEN'

Show Schema

{
  "id": "6385ba99976a7719120001d3",
  "sections": [
    {
      "label": "Personal Information",
      "fields": [
        {
          "name": "first_name",
          "label": "First name",
          "description": "",
          "type": "SingleLineText",
          "required": "always"
        },
        {
          "name": "last_name",
          "label": "Last name",
          "description": "",
          "type": "SingleLineText",
          "required": "always"
        },
        {
          "name": "email",
          "label": "Email address",
          "description": "",
          "type": "SmartEmail",
          "required": "always"
        },
        {
          "name": "__secondary_email",
          "label": "Secondary email",
          "description": "",
          "type": "SmartEmail",
          "required": "never"
        },
        {
          "name": "__date_of_birth",
          "label": "Date of birth",
          "description": "",
          "type": "Date",
          "required": "never"
        },
        {
          "name": "__nationality",
          "label": "Nationality",
          "description": "",
          "type": "Country",
          "required": "never"
        },
        {
          "name": "__gender",
          "label": "Gender",
          "description": "",
          "type": "DropDown",
          "required": "never",
          "options": [
            "Male",
            "Female",
            "Non-binary",
            "Prefer not to say"
          ]
        },
        {
          "name": "__phone",
          "label": "Phone number",
          "description": "",
          "type": "SingleLineText",
          "required": "never"
        },
        {
          "name": "__address",
          "label": "Home address",
          "description": "",
          "type": "Address",
          "required": "never"
        }
      ]
    },
    {
      "label": "Academic Background",
      "fields": [
        {
          "name": "__gmat_score",
          "label": "GMAT Score",
          "description": "",
          "type": "Number",
          "required": "never"
        },
        {
          "name": "__scholarship",
          "label": "Scholarship Interest",
          "description": "",
          "type": "CheckBox",
          "required": "never",
          "options": [
            "Merit",
            "Need-based",
            "Diversity"
          ]
        }
      ]
    }
  ]
}

Successful response.