Sign in

Get API v1 colleges

Changed on
get/api/v1/colleges/

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of colleges to return

Example:200
offsetinteger

Number of colleges to skip

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

totalinteger required

Total number of colleges returned

Example response

{
  "$schema": "https://example.com/schemas/ListCollegesResponse.json",
  "colleges": [
    {
      "$schema": "https://example.com/schemas/GetCollegeResponse.json",
      "academic_rank": 53,
      "city": "Boston",
      "division_rank": 1,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "logo": "https://example.com/logo.png",
      "name": "Northeastern University",
      "state": "Massachusetts",
      "website": "https://www.northeastern.edu"
    }
  ]
}

Changes

  • 677e53c52692Revision changes
    • ○

      added the new optional query request parameter limit

    • ○

      added the new optional query request parameter offset

    • ○

      added the required property to the response with the status

  • 2d3d370006deRevision changes
    • ○

      endpoint added