School Years

This page describes all the APIs relating to school years (academic years).

Get all School Years

get

/api/v3/school_years

Retrieves a list of all school years. Results are paginated. Use the page and per_page query parameters to control pagination.

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

Responses

200

school years found

application/json

get/api/v3/school_years

GET /api/v3/school_years HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

school years found

{
  "school_years": [
    {
      "id": 1,
      "name": "August 2024",
      "begins_at": 2024,
      "start_date": "2024-08-15",
      "end_date": "2025-08-14",
      "enabled": true
    }
  ],
  "meta": {
    "pages": 1,
    "per_page": 50
  }
}

Get a School Year

get

/api/v3/school_years/{id}

Fetch an instance of a school year

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Serial database ID that uniquely identifies a school year record in OpenApply

Responses

200

school year found

application/json

404

school year not found

application/json

get/api/v3/school_years/{id}

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

{
  "school_year": {
    "id": 1,
    "name": "August 2024",
    "begins_at": 2024,
    "start_date": "2024-08-15",
    "end_date": "2025-08-14",
    "enabled": true
  }
}