Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Parents

This page describes all the APIs relating to parents.

Get all Parents

get
/api/v3/parents
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageinteger · min: 1Optional

The page number of results to return.

Default: 1
per_pageinteger · min: 1 · max: 200Optional

Request for how many records to return.

Default: 50
countintegerOptional

Synonym for per_page

since_datestring · date_timeOptional

Return results updated since the specified date, in UTC timezone

Example: 2025-01-01T00:00:00Z
since_idintegerOptional

Return results with an ID greater than the specified ID.

child_idsstringOptional
Responses
200

successful

application/json
get/api/v3/parents
GET /api/v3/parents HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

successful

{
  "parents": [
    {
      "id": 1,
      "first_name": "text",
      "last_name": "text",
      "other_name": "text",
      "preferred_name": "text",
      "email": "text",
      "student_id": "text",
      "address": "text",
      "address_ii": "text",
      "city": "text",
      "state": "text",
      "postal_code": "text",
      "enrollment_year": 1,
      "birth_date": "2026-01-01",
      "passport_id": "text",
      "gender": "Male",
      "country": "text",
      "serial_number": 1,
      "custom_id": "text",
      "name": "text",
      "parent_id": "text",
      "prefix": "text",
      "phone": "text",
      "mobile_phone": "text",
      "parent_role": "text",
      "full_address": "text",
      "managebac_parent_id": "text",
      "mb_id": "text",
      "profile_photo": "text",
      "profile_photo_updated_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z",
      "child_ids": [
        1
      ],
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "meta": {
    "pages": 1,
    "per_page": 1,
    "page": 1
  }
}

Create a parent

post
/api/v3/parents

Create a parent. Returns the unique id in the body as well as attributes if successful.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
fieldsstringOptional

Comma-separated list of fields to include in the response. Supports nested fields using parentheses

Example: id,name,custom_fields(parent_guardians(id,email))
Body
first_namestringRequired
last_namestringRequired
other_namestring · nullableOptional
preferred_namestring · nullableOptional
emailstringRequired
student_idstringOptional
addressstring · nullableOptional
address_iistring · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
postal_codestring · nullableOptional
enrollment_yearinteger · nullableOptional
birth_datestring · date · nullableOptional
passport_idstring · nullableOptional
genderstring · enum · nullableOptionalPossible values:
countrystring · nullableOptional

The ISO 3166 country name

Responses
201

successful

application/json
idintegerOptional

Serial database ID that uniquey identifies the parent record

first_namestringOptional
last_namestringOptional
other_namestring · nullableOptional
preferred_namestring · nullableOptional
emailstringOptional
student_idstringOptional
addressstringOptional
address_iistring · nullableOptional
citystringOptional
statestringOptional
postal_codestringOptional
enrollment_yearinteger · nullableOptional
birth_datestring · date · nullableOptional
passport_idstring · nullableOptional
genderstring · enum · nullableOptionalPossible values:
countrystring · nullableOptional

The ISO 3166 country name

serial_numberintegerOptional
custom_idstringOptional
namestringOptional
parent_idstringOptional

Human-readable unique identifier commonly used for record reconsolidation across platforms. Populated and maintained by school

prefixstring · nullableOptional
phonestring · nullableOptional
mobile_phonestring · nullableOptional
parent_rolestringOptional
full_addressstring · nullableOptional
managebac_parent_idstring · nullableOptional
mb_idstring · nullableOptional

Internal reference ID maintained by Faria SyncHub for integration with ManageBac

profile_photostring · nullableOptional
profile_photo_updated_atstring · date-time · nullableOptional
updated_atstring · date-time · nullableOptional
child_idsinteger[]Optional

Array of student ID of children associated with this parent.

post/api/v3/parents
POST /api/v3/parents HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 306

{
  "first_name": "text",
  "last_name": "text",
  "other_name": "text",
  "preferred_name": "text",
  "email": "text",
  "student_id": "text",
  "address": "text",
  "address_ii": "text",
  "city": "text",
  "state": "text",
  "postal_code": "text",
  "enrollment_year": 1,
  "birth_date": "2026-01-01",
  "passport_id": "text",
  "gender": "Male",
  "country": "text"
}
{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "other_name": "text",
  "preferred_name": "text",
  "email": "text",
  "student_id": "text",
  "address": "text",
  "address_ii": "text",
  "city": "text",
  "state": "text",
  "postal_code": "text",
  "enrollment_year": 1,
  "birth_date": "2026-01-01",
  "passport_id": "text",
  "gender": "Male",
  "country": "text",
  "serial_number": 1,
  "custom_id": "text",
  "name": "text",
  "parent_id": "text",
  "prefix": "text",
  "phone": "text",
  "mobile_phone": "text",
  "parent_role": "text",
  "full_address": "text",
  "managebac_parent_id": "text",
  "mb_id": "text",
  "profile_photo": "text",
  "profile_photo_updated_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "child_ids": [
    1
  ],
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Get a Parent

get
/api/v3/parents/{id}

Fetch an instance of a parent

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Serial database ID used to refer to a unique parent record in OpenApply

Query parameters
fieldsstringOptional

Comma-separated list of fields to include in the response. Supports nested fields using parentheses

Example: id,name,custom_fields(parent_guardians(id,email))
Responses
200

successful

application/json
idintegerOptional

Serial database ID that uniquey identifies the parent record

first_namestringOptional
last_namestringOptional
other_namestring · nullableOptional
preferred_namestring · nullableOptional
emailstringOptional
student_idstringOptional
addressstringOptional
address_iistring · nullableOptional
citystringOptional
statestringOptional
postal_codestringOptional
enrollment_yearinteger · nullableOptional
birth_datestring · date · nullableOptional
passport_idstring · nullableOptional
genderstring · enum · nullableOptionalPossible values:
countrystring · nullableOptional

The ISO 3166 country name

serial_numberintegerOptional
custom_idstringOptional
namestringOptional
parent_idstringOptional

Human-readable unique identifier commonly used for record reconsolidation across platforms. Populated and maintained by school

prefixstring · nullableOptional
phonestring · nullableOptional
mobile_phonestring · nullableOptional
parent_rolestringOptional
full_addressstring · nullableOptional
managebac_parent_idstring · nullableOptional
mb_idstring · nullableOptional

Internal reference ID maintained by Faria SyncHub for integration with ManageBac

profile_photostring · nullableOptional
profile_photo_updated_atstring · date-time · nullableOptional
updated_atstring · date-time · nullableOptional
child_idsinteger[]Optional

Array of student ID of children associated with this parent.

get/api/v3/parents/{id}
GET /api/v3/parents/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "other_name": "text",
  "preferred_name": "text",
  "email": "text",
  "student_id": "text",
  "address": "text",
  "address_ii": "text",
  "city": "text",
  "state": "text",
  "postal_code": "text",
  "enrollment_year": 1,
  "birth_date": "2026-01-01",
  "passport_id": "text",
  "gender": "Male",
  "country": "text",
  "serial_number": 1,
  "custom_id": "text",
  "name": "text",
  "parent_id": "text",
  "prefix": "text",
  "phone": "text",
  "mobile_phone": "text",
  "parent_role": "text",
  "full_address": "text",
  "managebac_parent_id": "text",
  "mb_id": "text",
  "profile_photo": "text",
  "profile_photo_updated_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "child_ids": [
    1
  ],
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Update a parent

patch
/api/v3/parents/{id}

Updates a parent

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Serial database ID used to refer to a unique parent record in OpenApply

Body
first_namestringOptional
last_namestringOptional
other_namestring · nullableOptional
preferred_namestring · nullableOptional
emailstringOptional
student_idstringOptional
addressstring · nullableOptional
address_iistring · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
postal_codestring · nullableOptional
enrollment_yearinteger · nullableOptional
birth_datestring · date · nullableOptional
passport_idstring · nullableOptional
genderstring · enum · nullableOptionalPossible values:
countrystring · nullableOptional

The ISO 3166 country name

Responses
200

successful

application/json
idintegerOptional

Serial database ID that uniquey identifies the parent record

first_namestringOptional
last_namestringOptional
other_namestring · nullableOptional
preferred_namestring · nullableOptional
emailstringOptional
student_idstringOptional
addressstringOptional
address_iistring · nullableOptional
citystringOptional
statestringOptional
postal_codestringOptional
enrollment_yearinteger · nullableOptional
birth_datestring · date · nullableOptional
passport_idstring · nullableOptional
genderstring · enum · nullableOptionalPossible values:
countrystring · nullableOptional

The ISO 3166 country name

serial_numberintegerOptional
custom_idstringOptional
namestringOptional
parent_idstringOptional

Human-readable unique identifier commonly used for record reconsolidation across platforms. Populated and maintained by school

prefixstring · nullableOptional
phonestring · nullableOptional
mobile_phonestring · nullableOptional
parent_rolestringOptional
full_addressstring · nullableOptional
managebac_parent_idstring · nullableOptional
mb_idstring · nullableOptional

Internal reference ID maintained by Faria SyncHub for integration with ManageBac

profile_photostring · nullableOptional
profile_photo_updated_atstring · date-time · nullableOptional
updated_atstring · date-time · nullableOptional
child_idsinteger[]Optional

Array of student ID of children associated with this parent.

patch/api/v3/parents/{id}
PATCH /api/v3/parents/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 306

{
  "first_name": "text",
  "last_name": "text",
  "other_name": "text",
  "preferred_name": "text",
  "email": "text",
  "student_id": "text",
  "address": "text",
  "address_ii": "text",
  "city": "text",
  "state": "text",
  "postal_code": "text",
  "enrollment_year": 1,
  "birth_date": "2026-01-01",
  "passport_id": "text",
  "gender": "Male",
  "country": "text"
}
{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "other_name": "text",
  "preferred_name": "text",
  "email": "text",
  "student_id": "text",
  "address": "text",
  "address_ii": "text",
  "city": "text",
  "state": "text",
  "postal_code": "text",
  "enrollment_year": 1,
  "birth_date": "2026-01-01",
  "passport_id": "text",
  "gender": "Male",
  "country": "text",
  "serial_number": 1,
  "custom_id": "text",
  "name": "text",
  "parent_id": "text",
  "prefix": "text",
  "phone": "text",
  "mobile_phone": "text",
  "parent_role": "text",
  "full_address": "text",
  "managebac_parent_id": "text",
  "mb_id": "text",
  "profile_photo": "text",
  "profile_photo_updated_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "child_ids": [
    1
  ],
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Update parent custom fields

patch
/api/v3/parents/{id}/custom_fields

Updates parent custom fields by field ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Parent ID

Body
Responses
200

successful

application/json
patch/api/v3/parents/{id}/custom_fields
PATCH /api/v3/parents/{id}/custom_fields HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
{
  "parent": {
    "id": 1,
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}
PreviousStudents
NextRelationships

Last updated