> For the complete documentation index, see [llms.txt](https://guide.fariaedu.com/integrations-portal/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.fariaedu.com/integrations-portal/openapply/public-rest-apis/v3/models.md).

# Models

## The Student object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"Student":{"type":"object","properties":{"id":{"type":"integer","description":"Serial database ID that uniquely identifies the student record"},"first_name":{"type":"string","readOnly":false},"last_name":{"type":"string","readOnly":false},"email":{"type":"string","readOnly":false},"student_id":{"type":"string","description":"Human-readable identifier commonly used for record reconciliation across platforms. Populated and maintained by the school.","nullable":true,"readOnly":false},"address":{"type":"string","nullable":true,"readOnly":false},"address_ii":{"type":"string","nullable":true,"readOnly":false},"city":{"type":"string","nullable":true,"readOnly":false},"state":{"type":"string","nullable":true,"readOnly":false},"postal_code":{"type":"string","nullable":true,"readOnly":false},"enrollment_year":{"type":"integer","nullable":true,"readOnly":false},"birth_date":{"type":"string","format":"date","nullable":true,"readOnly":false},"grade":{"type":"string","description":"The grade"},"status":{"nullable":true,"type":"string","enum":["pending","applied","wait-listed","admitted","declined","enrolled","graduated","withdrawn"],"description":"The state of the application","readOnly":false},"country":{"type":"string","description":"The ISO 3166 country name","nullable":true},"other_name":{"type":"string","nullable":true},"preferred_name":{"type":"string","nullable":true},"name":{"type":"string"},"gender":{"type":"string","enum":["Male","Female","Non - Binary"],"nullable":true},"custom_status_name":{"type":"string","nullable":true,"description":"The school-specific display name for the current status","readOnly":true},"status_level":{"type":"string","description":"A more specific classification under the parent `status`, used to indicate the detailed sub-status of the student.","nullable":true},"status_changed_at":{"type":"string","format":"date-time","nullable":true},"status_level_changed_at":{"type":"string","format":"date-time","nullable":true,"description":"When the current `status_level` was last assigned or changed. `null` when the student has no status level."},"updated_at":{"type":"string","format":"date-time","nullable":true},"latest_activity_date":{"type":"string","format":"date-time","nullable":true},"nationality":{"type":"string","nullable":true},"serial_number":{"type":"integer","nullable":true},"agent_id":{"type":"integer","nullable":true,"description":"The ID of the agent this student is associated to"},"managebac_student_id":{"type":"integer","nullable":true,"description":"Synonym for mb_id"},"mb_id":{"type":"string","nullable":true,"description":"Internal reference ID maintained by Faria SyncHub for integration with ManageBac"},"campus_id":{"type":"integer","nullable":true},"campus":{"type":"string","nullable":true,"description":"The name of the campus this student is associated to"},"custom_id":{"type":"string","nullable":true,"description":"Synonym for `student_id`"},"applicant_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"applied_at":{"type":"string","format":"date-time","nullable":true},"enrolled_at":{"type":"string","format":"date-time","nullable":true},"inquired_date":{"type":"string","format":"date-time","nullable":true},"inquired_at":{"type":"string","format":"date-time","nullable":true},"applied_date":{"type":"string","format":"date-time","nullable":true},"admitted_date":{"type":"string","format":"date-time","nullable":true},"wait_listed_date":{"type":"string","format":"date-time","nullable":true},"declined_date":{"type":"string","format":"date-time","nullable":true},"enrolled_date":{"type":"string","format":"date-time","nullable":true},"withdrawn_date":{"type":"string","format":"date-time","nullable":true},"graduated_date":{"type":"string","format":"date-time","nullable":true},"representative":{"type":"string","nullable":true},"enrollment_date":{"type":"string","format":"date"},"source_campaign":{"type":"string","nullable":true},"contact_date":{"type":"string","format":"date","nullable":true},"checklist_state":{"type":"string"},"passport_id":{"type":"string","nullable":true},"enrollment_grade":{"type":"string","nullable":true},"parent_ids":{"type":"array","items":{"type":"integer"},"description":"Array of parent ID of parents associated with this student."},"sibling_ids":{"type":"array","items":{"type":"integer"}},"student_flags":{"type":"array","items":{"type":"string"}},"sis_ids":{"type":"array","description":"External SIS integration identifiers. Only populated for integrations enabled on the school (iSAMS, PowerSchool, Engaged).","items":{"type":"object","properties":{"name":{"type":"string","description":"SIS integration name (e.g. iSAMS, PowerSchool, Engaged)"},"value":{"type":"string","description":"The external SIS identifier for this student"}}}},"application_form":{"type":"object","description":"The student's current Application form attachment. The pointer moves when a student re-applies; earlier application years remain available in `application_history`.","properties":{"id":{"type":"integer","nullable":true,"description":"The Application form the student is attached to; `null` when unattached. Discover form ids via `GET /api/v3/forms` (its `applicable_academic_years` maps years to form ids only for schools with per-year form versions; standalone forms report `[]` there)."},"academic_year":{"type":"integer","nullable":true,"description":"The academic year THIS student applied for (from their Applied status event), not the form's own year list. Falls back to the student's `enrollment_year` when they never reached the Applied status."}}},"application_history":{"type":"array","description":"One entry per academic year the student reached the Applied status: the earliest applied date per year, ordered by year. Survives re-applies, so `min(academic_year)` is the year the student first applied. Empty when the student never applied. Form ids are intentionally absent: earlier-year form submissions are destroyed when a student re-applies. Not the same structure as `application_history` in the `GET /api/v3/students/{id}/status_history` response, which lists individual status-change events.","items":{"type":"object","properties":{"academic_year":{"type":"integer"},"applied_date":{"type":"string","format":"date"}}}},"reenrollments":{"type":"array","items":{"$ref":"#/components/schemas/Reenrollment"}},"custom_fields":{"$ref":"#/components/schemas/CustomFields"},"archived":{"type":"boolean","description":"Whether the student is archived (typically Graduated or Withdrawn)","readOnly":false},"archived_on":{"type":"string","format":"date","nullable":true,"description":"The date when the student was archived","readOnly":false},"has_invalid_status_history":{"type":"boolean","description":"Whether the student's application status history is internally inconsistent","readOnly":true}}},"Reenrollment":{"type":"object","properties":{"ree_year":{"type":"string"},"ree_grade":{"type":"string"},"ree_status":{"type":"string"},"ree_decision_date":{"type":"string","format":"date"},"ree_status_changed_at":{"type":"string","format":"date-time"}},"required":["ree_year","ree_grade","ree_status"]},"CustomFields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldValue"}},"CustomFieldValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}]}}}}
```

## The Parent object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"Parent":{"type":"object","properties":{"id":{"type":"integer","description":"Serial database ID that uniquey identifies the parent record"},"first_name":{"type":"string"},"last_name":{"type":"string"},"other_name":{"type":"string","nullable":true},"preferred_name":{"type":"string","nullable":true},"email":{"type":"string"},"student_id":{"type":"string"},"address":{"type":"string"},"address_ii":{"type":"string","nullable":true},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"},"enrollment_year":{"type":"integer","nullable":true},"birth_date":{"type":"string","format":"date","nullable":true},"passport_id":{"type":"string","nullable":true},"gender":{"type":"string","enum":["Male","Female","Non - Binary"],"nullable":true},"country":{"type":"string","description":"The ISO 3166 country name","nullable":true},"serial_number":{"type":"integer"},"custom_id":{"type":"string"},"name":{"type":"string"},"parent_id":{"type":"string","description":"Human-readable unique identifier commonly used for record reconsolidation across platforms. Populated and maintained by school"},"prefix":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile_phone":{"type":"string","nullable":true},"parent_role":{"type":"string"},"full_address":{"type":"string","nullable":true},"managebac_parent_id":{"type":"string","nullable":true},"mb_id":{"type":"string","nullable":true,"description":"Internal reference ID maintained by Faria SyncHub for integration with ManageBac"},"profile_photo":{"type":"string","nullable":true},"profile_photo_updated_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"child_ids":{"type":"array","items":{"type":"integer"},"description":"Array of student ID of children associated with this parent."},"custom_fields":{"$ref":"#/components/schemas/CustomFields"}}},"CustomFields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldValue"}},"CustomFieldValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}]}}}}
```

## The StudentUpdate object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"StudentUpdate":{"type":"object","properties":{"first_name":{"type":"string","readOnly":false},"last_name":{"type":"string","readOnly":false},"email":{"type":"string","readOnly":false},"student_id":{"type":"string","description":"Human-readable identifier commonly used for record reconciliation across platforms. Populated and maintained by the school.","nullable":true,"readOnly":false},"address":{"type":"string","nullable":true,"readOnly":false},"address_ii":{"type":"string","nullable":true,"readOnly":false},"city":{"type":"string","nullable":true,"readOnly":false},"state":{"type":"string","nullable":true,"readOnly":false},"postal_code":{"type":"string","nullable":true,"readOnly":false},"enrollment_year":{"type":"integer","nullable":true,"readOnly":false},"birth_date":{"type":"string","format":"date","nullable":true,"readOnly":false},"grade":{"type":"string","description":"The grade label (e.g. 'Grade 9', 'K'). Must match a valid grade configured for the school.","nullable":true,"readOnly":false},"status":{"nullable":true,"type":"string","enum":["pending","applied","wait-listed","admitted","declined","enrolled","graduated","withdrawn"],"description":"The state of the application","readOnly":false},"effective_on":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"The date when the status change became effective (YYYY-MM-DD format only). Only used when status is being changed. If omitted, defaults to the later of today's date or the latest status history's effective date, in the school's configured timezone.","nullable":true,"readOnly":false},"country":{"type":"string","description":"The ISO 3166 country name","nullable":true},"other_name":{"type":"string","nullable":true},"preferred_name":{"type":"string","nullable":true}}}}}}
```

## The ParentUpdate object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"ParentUpdate":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"other_name":{"type":"string","nullable":true},"preferred_name":{"type":"string","nullable":true},"email":{"type":"string"},"student_id":{"type":"string"},"address":{"type":"string","nullable":true},"address_ii":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"enrollment_year":{"type":"integer","nullable":true},"birth_date":{"type":"string","format":"date","nullable":true},"passport_id":{"type":"string","nullable":true},"gender":{"type":"string","enum":["Male","Female","Non - Binary"],"nullable":true},"country":{"type":"string","description":"The ISO 3166 country name","nullable":true}}}}}}
```

## The StudentCreate object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"StudentCreate":{"type":"object","properties":{"first_name":{"type":"string","readOnly":false},"last_name":{"type":"string","readOnly":false},"email":{"type":"string","readOnly":false},"student_id":{"type":"string","description":"Human-readable identifier commonly used for record reconciliation across platforms. Populated and maintained by the school.","nullable":true,"readOnly":false},"address":{"type":"string","nullable":true,"readOnly":false},"address_ii":{"type":"string","nullable":true,"readOnly":false},"city":{"type":"string","nullable":true,"readOnly":false},"state":{"type":"string","nullable":true,"readOnly":false},"postal_code":{"type":"string","nullable":true,"readOnly":false},"enrollment_year":{"type":"integer","nullable":true,"readOnly":false},"birth_date":{"type":"string","format":"date","nullable":true,"readOnly":false},"grade":{"type":"string","description":"The grade label (e.g. 'Grade 9', 'K'). Must match a valid grade configured for the school.","nullable":true,"readOnly":false},"status":{"nullable":true,"type":"string","enum":["pending","applied","wait-listed","admitted","declined","enrolled","graduated","withdrawn"],"description":"The state of the application","readOnly":false},"country":{"type":"string","description":"The ISO 3166 country name","nullable":true},"other_name":{"type":"string","nullable":true},"preferred_name":{"type":"string","nullable":true}},"required":["first_name","last_name"]}}}}
```

## The StudentStatusHistory object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"StudentStatusHistory":{"type":"object","properties":{"student":{"type":"object","properties":{"id":{"type":"integer"},"serial_number":{"type":"string"},"custom_id":{"type":"string"},"applicant_id":{"type":"string"},"application_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"custom_name":{"type":"string"},"code":{"type":"string"}}},"enrollment_year":{"type":"string"},"effective_on":{"type":"string","format":"date"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"status_level":{"type":"object","nullable":true,"properties":{"id":{"type":"integer"},"name":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}}}}}}}}
```

## The ParentCreate object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"ParentCreate":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"other_name":{"type":"string","nullable":true},"preferred_name":{"type":"string","nullable":true},"email":{"type":"string"},"student_id":{"type":"string"},"address":{"type":"string","nullable":true},"address_ii":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"enrollment_year":{"type":"integer","nullable":true},"birth_date":{"type":"string","format":"date","nullable":true},"passport_id":{"type":"string","nullable":true},"gender":{"type":"string","enum":["Male","Female","Non - Binary"],"nullable":true},"country":{"type":"string","description":"The ISO 3166 country name","nullable":true}},"required":["first_name","last_name","email"]}}}}
```

## The Relationship object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"Relationship":{"type":"object","properties":{"parent_id":{"type":"integer","description":"Unique identifier for the parent"},"student_ids":{"type":"array","items":{"type":"integer"},"description":"Array of student IDs associated with this parent"},"relationships":{"type":"array","items":{"type":"object","properties":{"student_id":{"type":"integer","description":"Student ID"},"relationship":{"type":"string","description":"Relationship role between parent and student"}}},"description":"Array of relationship objects between parent and students"}},"required":["student_id","parent_ids"]}}}}
```

## The Staff object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"Staff":{"type":"object","properties":{"id":{"type":"integer","description":"Serial database ID that uniquely identifies the staff record"},"isams_id":{"type":"string","nullable":true,"description":"External iSAMS system identifier"},"managebac_user_id":{"type":"string","nullable":true,"description":"External ManageBac system identifier"},"email":{"type":"string","description":"Staff member email address"},"first_name":{"type":"string","description":"Staff member first name"},"last_name":{"type":"string","description":"Staff member last name"},"title":{"type":"string","nullable":true,"description":"Staff member job title or position"},"properties":{"type":"object","nullable":true,"description":"Additional staff properties","properties":{"phone":{"type":"string","nullable":true,"description":"Staff member phone number"}}},"admin":{"type":"boolean","description":"Whether the staff member has admin privileges"},"can_admit_and_enroll":{"type":"boolean","description":"Whether the staff member can admit and enroll students"},"can_edit_notes_and_files":{"type":"boolean","description":"Whether the staff member can edit notes and files"},"can_read_only":{"type":"boolean","description":"Whether the staff member has read-only access"},"admission_contact":{"type":"boolean","description":"Whether the staff member is an admission contact"},"type":{"type":"string","description":"Staff member type"},"department":{"type":"object","nullable":true,"description":"Department information","properties":{"id":{"type":"integer","description":"Department ID"},"name":{"type":"string","description":"Department name"}}},"using_sso":{"type":"boolean","description":"Whether the staff member uses single sign-on"},"email_verified":{"type":"boolean","description":"Whether the email address has been verified"},"last_sign_in_at":{"type":"string","format":"date-time","nullable":true,"description":"Last sign-in timestamp"},"created_at":{"type":"string","format":"date-time","description":"Record creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Record last update timestamp"},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"Record deletion timestamp"},"archived_at":{"type":"string","format":"date-time","nullable":true,"description":"Record archival timestamp"},"otp_required_for_login":{"type":"boolean","nullable":true,"description":"Whether OTP is required for login"},"token_last_time_used_at":{"type":"string","format":"date-time","nullable":true,"description":"Last time an API token was used"}}}}}}
```

## The Reenrollment object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"Reenrollment":{"type":"object","properties":{"ree_year":{"type":"string"},"ree_grade":{"type":"string"},"ree_status":{"type":"string"},"ree_decision_date":{"type":"string","format":"date"},"ree_status_changed_at":{"type":"string","format":"date-time"}},"required":["ree_year","ree_grade","ree_status"]}}}}
```

## The StatusEvent object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"StatusEvent":{"type":"object","properties":{"student":{"type":"object","properties":{"id":{"type":"integer"},"custom_id":{"type":"string"},"enrollment_year":{"type":"integer"}}},"to":{"type":"object","properties":{"status":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"display_name":{"type":"string"},"updated_at":{"type":"string","format":"date"},"created_at":{"type":"string","format":"date"}}},"status_level":{"type":"object","nullable":true,"properties":{"id":{"type":"integer"},"name":{"type":"string"},"updated_at":{"type":"string","format":"date"},"created_at":{"type":"string","format":"date"}}}}},"from":{"type":"object","nullable":true,"properties":{"status":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"display_name":{"type":"string"},"updated_at":{"type":"string","format":"date"},"created_at":{"type":"string","format":"date"}}},"status_level":{"type":"object","nullable":true,"properties":{"id":{"type":"integer"},"name":{"type":"string"},"updated_at":{"type":"string","format":"date"},"created_at":{"type":"string","format":"date"}}}}}}}}}}
```

## The CustomFieldValue object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"CustomFieldValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}]}}}}
```

## The CustomFields object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"CustomFields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldValue"}},"CustomFieldValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}]}}}}
```

## The TagSlug object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"TagSlug":{"type":"array","items":{"type":"string"}}}}}
```

## The StudentSlug object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"StudentSlug":{"type":"array","items":{"type":"string"}}}}}
```

## The ParentSlug object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"ParentSlug":{"type":"array","items":{"type":"string"}}}}}
```

## The FormSlug object

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"components":{"schemas":{"FormSlug":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string","nullable":true}}}}}}
```