In order to facilitate queries about a school's data, OpenApply's public API has endpoints to search for parent and student data via the "Search by searchable keys" endpoints. Additionally, help in seeing all the custom fields, and thus the correct label to select on are available in "Retrieve searchable keys".
Specific information on using these endpoints see further details in: How to download custom fields and search by custom fields
A few standard searches for the search endpoint are included in our Postman collection, including searching by enrollment year and enrollment status.
To search by enrollment year, just enter the year with the parameter student[enrollment_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, remember to change the address to .cn or .eu
To search by enrollment status, use either of the values in the table:
| Status | Code |
|---|---|
| "pending" | 10 |
| "applied" | 20 |
| "admitted" | 30 |
| "wait_listed" | 40 |
| "declined" | 50 |
| "enrolled" | 60 |
| "graduated" | 70 |
| "withdrawn" | 80 |
GET `https://{subdomain}.openapply.com/api/v3/students/search?student[status]=60`
GET `https://{subdomain}.openapply.com/api/v3/students/search?student[status]=enrolled`