Search
This page describes all the APIs relating to querying by student or parent attributes
Fetch attributes that can be used for requests to /parents/search.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200
successful
application/json
parent_slugstring[]Optional
get/api/v3/parents/searchable_keys
GET /api/v3/parents/searchable_keys HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
successful
{
"parent_slug": [
"text"
],
"form_slug": [
{
"ANY_ADDITIONAL_PROPERTY": "text"
}
]
}Return parent records that contain matching attribute/value pairs
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
parentobjectOptional
Search criteria for parents
fieldobjectOptional
Search criteria for custom fields
Responses
200
successful
application/json
422
unprocessable entity
application/json
get/api/v3/parents/search
GET /api/v3/parents/search HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"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"
}
}
]
}Fetch attributes that can be used for requests to /students/search.
The response's root will include arrays mapped to keys in the pattern of "x_slugs" (i.e. "form_slug") where x is the scope of included elements.
For example, on the student application form ("student_slug"), or form "form_slug", supplementary forms, etc.
The elements of the array are strings (i.e. "first_name") that refer to field name that can be targeted for search.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200
successful
application/json
tag_slugstring[]Optional
student_slugstring[]Optional
get/api/v3/students/searchable_keys
GET /api/v3/students/searchable_keys HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
successful
{
"tag_slug": [
"text"
],
"student_slug": [
"text"
],
"form_slug": [
{
"ANY_ADDITIONAL_PROPERTY": "text"
}
]
}Return student records that contain matching attribute/value pairs
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
studentobjectOptional
Search criteria for students
tagobjectOptional
Search criteria for tags
fieldobjectOptional
Search criteria for custom fields
fieldsstringOptionalExample:
Comma-separated list of fields to include in the response. Supports nested fields using parentheses
id,name,custom_fields(parent_guardians(id,email))Responses
200
successful
application/json
422
unprocessable entity
application/json
get/api/v3/students/search
GET /api/v3/students/search HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"students": [
{
"id": 1,
"first_name": "text",
"last_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",
"grade": "text",
"status": "pending",
"country": "text",
"other_name": "text",
"preferred_name": "text",
"name": "text",
"gender": "Male",
"custom_status_name": "text",
"status_level": "text",
"status_changed_at": "2026-01-01T00:00:00.000Z",
"status_level_changed_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"latest_activity_date": "2026-01-01T00:00:00.000Z",
"nationality": "text",
"serial_number": 1,
"agent_id": 1,
"managebac_student_id": 1,
"mb_id": "text",
"campus_id": 1,
"campus": "text",
"custom_id": "text",
"applicant_id": "text",
"tags": [
"text"
],
"applied_at": "2026-01-01T00:00:00.000Z",
"enrolled_at": "2026-01-01T00:00:00.000Z",
"inquired_date": "2026-01-01T00:00:00.000Z",
"inquired_at": "2026-01-01T00:00:00.000Z",
"applied_date": "2026-01-01T00:00:00.000Z",
"admitted_date": "2026-01-01T00:00:00.000Z",
"wait_listed_date": "2026-01-01T00:00:00.000Z",
"declined_date": "2026-01-01T00:00:00.000Z",
"enrolled_date": "2026-01-01T00:00:00.000Z",
"withdrawn_date": "2026-01-01T00:00:00.000Z",
"graduated_date": "2026-01-01T00:00:00.000Z",
"representative": "text",
"enrollment_date": "2026-01-01",
"source_campaign": "text",
"contact_date": "2026-01-01",
"checklist_state": "text",
"passport_id": "text",
"enrollment_grade": "text",
"parent_ids": [
1
],
"sibling_ids": [
1
],
"student_flags": [
"text"
],
"sis_ids": [
{
"name": "text",
"value": "text"
}
],
"application_form": {
"id": 1,
"academic_year": 1
},
"application_history": [
{
"academic_year": 1,
"applied_date": "2026-01-01"
}
],
"reenrollments": [
{
"ree_year": "text",
"ree_grade": "text",
"ree_status": "text",
"ree_decision_date": "2026-01-01",
"ree_status_changed_at": "2026-01-01T00:00:00.000Z"
}
],
"custom_fields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"archived": true,
"archived_on": "2026-01-01",
"has_invalid_status_history": true
}
]
}Last updated