{"note":"OpenAPI conversion -- returning structured metadata","name":"clever-com","description":"Data API","version":"1.2.0","base_url":"https://api.clever.com/v1.2","endpoints":44,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Data API\n@base https://api.clever.com/v1.2\n@version 1.2.0\n@auth OAuth2\n@endpoints 44\n@hint download_for_search\n@toc contacts(4), district_admins(2), districts(8), school_admins(3), schools(6), sections(7), students(7), teachers(7)\n\n@group contacts\n@endpoint GET /contacts\n@desc Returns a list of student contacts\n@optional {limit: any, starting_after: any, ending_before: any}\n@returns(200) OK Response\n\n@endpoint GET /contacts/{id}\n@desc Returns a specific student contact\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /contacts/{id}/district\n@desc Returns the district for a student contact\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /contacts/{id}/student\n@desc Returns the student for a student contact\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endgroup\n\n@group district_admins\n@endpoint GET /district_admins\n@desc Returns a list of district admins\n@optional {starting_after: any, ending_before: any, show_links: any}\n@returns(200) OK Response\n\n@endpoint GET /district_admins/{id}\n@desc Returns a specific district admin\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endgroup\n\n@group districts\n@endpoint GET /districts\n@desc Returns a list of districts. In practice this will only return the one district associated with the bearer token\n@returns(200) OK Response\n\n@endpoint GET /districts/{id}\n@desc Returns a specific district\n@required {id: any}\n@optional {include: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /districts/{id}/admins\n@desc Returns the admins for a district\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /districts/{id}/schools\n@desc Returns the schools for a district\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /districts/{id}/sections\n@desc Returns the sections for a district\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /districts/{id}/status\n@desc Returns the status of the district\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /districts/{id}/students\n@desc Returns the students for a district\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /districts/{id}/teachers\n@desc Returns the teachers for a district\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endgroup\n\n@group school_admins\n@endpoint GET /school_admins\n@desc Returns a list of school admins\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n\n@endpoint GET /school_admins/{id}\n@desc Returns a specific school admin\n@required {id: any}\n@optional {include: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /school_admins/{id}/schools\n@desc Returns the schools for a school admin\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endgroup\n\n@group schools\n@endpoint GET /schools\n@desc Returns a list of schools\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n\n@endpoint GET /schools/{id}\n@desc Returns a specific school\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /schools/{id}/district\n@desc Returns the district for a school\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /schools/{id}/sections\n@desc Returns the sections for a school\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /schools/{id}/students\n@desc Returns the students for a school\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /schools/{id}/teachers\n@desc Returns the teachers for a school\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endgroup\n\n@group sections\n@endpoint GET /sections\n@desc Returns a list of sections\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n\n@endpoint GET /sections/{id}\n@desc Returns a specific section\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /sections/{id}/district\n@desc Returns the district for a section\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /sections/{id}/school\n@desc Returns the school for a section\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /sections/{id}/students\n@desc Returns the students for a section\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /sections/{id}/teacher\n@desc Returns the primary teacher for a section\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /sections/{id}/teachers\n@desc Returns the teachers for a section\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endgroup\n\n@group students\n@endpoint GET /students\n@desc Returns a list of students\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n\n@endpoint GET /students/{id}\n@desc Returns a specific student\n@required {id: any}\n@optional {include: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /students/{id}/contacts\n@desc Returns the contacts for a student\n@required {id: any}\n@optional {limit: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /students/{id}/district\n@desc Returns the district for a student\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /students/{id}/school\n@desc Returns the primary school for a student\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /students/{id}/sections\n@desc Returns the sections for a student\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /students/{id}/teachers\n@desc Returns the teachers for a student\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endgroup\n\n@group teachers\n@endpoint GET /teachers\n@desc Returns a list of teachers\n@optional {limit: any, starting_after: any, ending_before: any, where: any}\n@returns(200) OK Response\n\n@endpoint GET /teachers/{id}\n@desc Returns a specific teacher\n@required {id: any}\n@optional {include: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /teachers/{id}/district\n@desc Returns the district for a teacher\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /teachers/{id}/grade_levels\n@desc Returns the grade levels for sections a teacher teaches\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /teachers/{id}/school\n@desc Retrieves school info for a teacher.\n@required {id: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /teachers/{id}/sections\n@desc Returns the sections for a teacher\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endpoint GET /teachers/{id}/students\n@desc Returns the students for a teacher\n@required {id: any}\n@optional {limit: any, starting_after: any, ending_before: any}\n@returns(200) OK Response\n@errors {404: Entity Not Found}\n\n@endgroup\n\n@end\n"}