> 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/forms.md).

# Forms

This page describes all the APIs relating to forms.

## List available forms

> Lists the school's published forms. Results are paginated. Use \`kind\` to\
> filter by a single form type. For schools that version their forms per\
> year, \`applicable\_academic\_years\` lets a consumer resolve an academic\
> year to that year's Application form id(s), for use with the\
> \`application\_form\_id\` filter on \`GET /api/v3/students\`. Schools whose\
> Application form is standalone (not year-versioned) normally return\
> \`\[]\` there; resolve years per student instead, via\
> \`application\_form.academic\_year\` / \`application\_history\` on\
> \`GET /api/v3/students\`, or the year-scoped\
> \`GET /api/v3/students/applied\`.<br>

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Forms","description":"This page describes all the APIs relating to forms."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v3/forms":{"get":{"summary":"List available forms","tags":["Forms"],"operationId":"listForms","description":"Lists the school's published forms. Results are paginated. Use `kind` to\nfilter by a single form type. For schools that version their forms per\nyear, `applicable_academic_years` lets a consumer resolve an academic\nyear to that year's Application form id(s), for use with the\n`application_form_id` filter on `GET /api/v3/students`. Schools whose\nApplication form is standalone (not year-versioned) normally return\n`[]` there; resolve years per student instead, via\n`application_form.academic_year` / `application_history` on\n`GET /api/v3/students`, or the year-scoped\n`GET /api/v3/students/applied`.\n","parameters":[{"name":"kind","in":"query","required":false,"description":"Filter by form kind.","schema":{"type":"string","enum":["roi","application","supplementary","questionnaire","reenrollment","reenrollment_undecided","reenrollment_declined","tour","exam_score","rubric","agent","idat","enrollment","feeder_school_reference","alumni","constituent","alumni_sign_up","advancement_event","contact"]}},{"name":"since_id","in":"query","required":false,"description":"Return results with an ID greater than the specified ID.","schema":{"type":"integer"}},{"name":"since_date","in":"query","required":false,"description":"Return results updated since the specified date, in UTC timezone","schema":{"type":"string","format":"date_time"}},{"name":"page","in":"query","required":false,"description":"The page number of results to return.","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"description":"Request for how many records to return.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"count","in":"query","required":false,"description":"Synonym for per_page","schema":{"type":"integer"}}],"responses":{"200":{"description":"forms found","content":{"application/json":{"schema":{"type":"object","properties":{"forms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"kind":{"type":"string","enum":["roi","application","supplementary","questionnaire","reenrollment","reenrollment_undecided","reenrollment_declined","tour","exam_score","rubric","agent","idat","enrollment","feeder_school_reference","alumni","constituent","alumni_sign_up","advancement_event","contact"]},"published":{"type":"boolean"},"field_count":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"},"applicable_academic_years":{"type":"array","items":{"type":"integer"},"description":"Academic years (4-digit start year) the form is configured for. Form Settings offers the setting only for forms inside a version group, where it picks which version serves a given year; re-enrollment and enrollment forms also carry years for their own flows. A standalone Application form normally returns an empty array even when students are attached."}}}},"meta":{"type":"object","properties":{"pages":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"}}}}}}}},"400":{"description":"invalid kind","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}}
```