Searching by enrollment year and enrollment status in OpenApply

Searching by Enrollment Year and Enrollment Status in OpenApply

In order to facilitate queries about a school's data, OpenApply's public API provides endpoints to search for parent and student data via the "Search by searchable keys" endpoints. Additionally, users can retrieve all available custom fields, allowing them to select the correct label when constructing search queries, via the "Retrieve searchable keys" endpoint.

Retrieving Searchable Keys

Before performing a search, it is useful to retrieve the available searchable fields using the Retrieve searchable keysendpoint. This ensures that the correct parameters are used in the search query.

Request:

GET https://{subdomain}.openapply.com/api/v3/students/searchable_keys

Response Example:

{
    "tag_slug": [
        "title",
        "title_wildcard"
    ],
    "student_slug": [
        "id",
        "student_id",
        "serial_number",
        "first_name",
        "first_name_wildcard",
        "last_name",
        "last_name_wildcard",
        "enrollment_year",
        "email",
        "status",
        "campus"
    ],
    "form_slug": [
        {
        }
    ]
}

This response lists the searchable fields available for querying student records. The student_slug section contains key identifiers such as enrollment_year and status, which can be used to construct API queries.

Searching by Searchable Keys

Once the searchable keys are retrieved, they can be used to construct API queries.

Searching by Enrollment Year

To search by enrollment year, use the student[enrollment_year] parameter and enter the desired year:

GET https://{subdomain}.openapply.com/api/v3/students/search?student[enrollment_year]=2022

Note: If your subdomain is in China or on the EU domain, update the URL to .cn or .eu accordingly.

Searching by Enrollment Status

Use the student[status] parameter with the corresponding status code or name from the table below:

Example queries:

GET https://{subdomain}.openapply.com/api/v3/students/search?student[status]=60

OR

GET https://{subdomain}.openapply.com/api/v3/students/search?student[status]=enrolled

Combining Search Parameters

Multiple search parameters can be combined in a single request to refine results. For example, to search for students who enrolled in 2022 and are currently enrolled:

GET https://{subdomain}.openapply.com/api/v3/students/search?student[enrollment_year]=2022&student[status]=60

Additional Search Criteria

Using the searchable keys retrieved earlier, other queries can be constructed, such as filtering by nationality or grade level:

GET https://{subdomain}.openapply.com/api/v3/students/search?student[nationality]=Canadian&student[grade_level]=10

By leveraging these endpoints effectively, users can perform precise searches on student data within OpenApply's API.

Search Custom Fields Criteria

The form_slug array returned by the "Retrieve searchable student/parent keys" provide the keys that can be used to construct a query. 

Response Example:

{
  "form_slug": [
    {
      "id": 91988,
      "type": "Student",
      "label": "Photo Consent",
      "name": "Photo Consent Y/N",
      "slug": "photo_consent_y_n",
      "wildcard": "photo_consent_y_n_wildcard"
    },
    // ...
}

The following query can be constructed for the "Search student by searchable keys", which will retrieve student records that have the value "Yes" for the "Photo Consent Y/N" field and enrollment year is 2025:

GET https://{subdomain}.openapply.com/api/v3/students/search?field[photo_consent_y_n]=Yes&student[enrollment_year]=2025

Notice the prefix for form slugs in the query is field while the prefix for student slugs is field .