v1.0.0Base URL: https://schools.syncnexa.co
OpenSchools API Documentation
The developer guide for querying institutions, faculties, departments, and validating university email domains.
Authentication
All requests must include your developer API key in the Authorization header (Authorization: Bearer ops_live_...) or X-API-Key header.
List & Search Institutions
GET
/v1/schoolsRetrieve a paginated list of tertiary institutions with filtering by country, category, ownership, and search terms.
Query Parameters
Parameter | Type | Description |
|---|---|---|
| search | string | Fuzzy search term matching name, acronym, city, or slug |
| category | string | Filter by university, polytechnic, college_of_education, monotechnic |
| ownership | string | Filter by federal, state, private |
| country | string | Two-letter ISO country code (default: NG) |
| limit | number | Items per page (default: 50, max: 100) |
cURL Requestbash
| 1 | curl -X GET "https://schools.syncnexa.co/v1/schools?ownership=federal&category=university" \ |
| 2 | -H "Authorization: Bearer YOUR_API_KEY" |
JSON Response (200 OK)json
| 1 | { |
| 2 | "status": "success", |
| 3 | "message": "schools_retrieved", |
| 4 | "data": { |
| 5 | "total": 1, |
| 6 | "limit": 50, |
| 7 | "offset": 0, |
| 8 | "schools": [ |
| 9 | { |
| 10 | "id": "sch_futo_ng", |
| 11 | "name": "Federal University of Technology, Owerri", |
| 12 | "short_name": "FUTO", |
| 13 | "slug": "futo", |
| 14 | "country": "Nigeria", |
| 15 | "country_code": "NG", |
| 16 | "state": "Imo", |
| 17 | "city": "Owerri", |
| 18 | "category": "university", |
| 19 | "ownership": "federal", |
| 20 | "accreditation_body": "NUC", |
| 21 | "accreditation_status": "accredited", |
| 22 | "established_year": 1980, |
| 23 | "domains": ["futo.edu.ng", "portal.futo.edu.ng"], |
| 24 | "portal_url": "https://portal.futo.edu.ng", |
| 25 | "website": "https://futo.edu.ng", |
| 26 | "logo_url": "https://assets.syncnexa.co/schools/logos/futo.png", |
| 27 | "syncid_enabled": true |
| 28 | } |
| 29 | ] |
| 30 | } |
| 31 | } |
Get Single School
GET
/v1/schools/:codeOrIdFetch complete metadata, campus locations, and structure for an institution using its slug, acronym, or ID.
Query Parameters
Parameter | Type | Description |
|---|---|---|
| codeOrId | string | School slug (futo), short name (FUTO), or ID (sch_futo_ng) |
cURL Requestbash
| 1 | curl -X GET "https://schools.syncnexa.co/v1/schools/futo" \ |
| 2 | -H "Authorization: Bearer YOUR_API_KEY" |
JSON Response (200 OK)json
| 1 | { |
| 2 | "status": "success", |
| 3 | "message": "school_retrieved", |
| 4 | "data": { |
| 5 | "id": "sch_futo_ng", |
| 6 | "name": "Federal University of Technology, Owerri", |
| 7 | "short_name": "FUTO", |
| 8 | "slug": "futo", |
| 9 | "state": "Imo", |
| 10 | "city": "Owerri", |
| 11 | "category": "university", |
| 12 | "ownership": "federal", |
| 13 | "domains": ["futo.edu.ng"], |
| 14 | "campuses": [ |
| 15 | { |
| 16 | "name": "Main Campus", |
| 17 | "location": "Ihiagwa / Eziobodo, Owerri West", |
| 18 | "latitude": 5.3855, |
| 19 | "longitude": 6.9928 |
| 20 | } |
| 21 | ], |
| 22 | "facultiesCount": 7, |
| 23 | "syncid_enabled": true |
| 24 | } |
| 25 | } |
Get Faculties & Departments Tree
GET
/v1/schools/:codeOrId/facultiesRetrieve the complete nested faculty tree with departments and degree offerings.
Query Parameters
Parameter | Type | Description |
|---|---|---|
| codeOrId | string | School slug or short code (e.g. futo) |
cURL Requestbash
| 1 | curl -X GET "https://schools.syncnexa.co/v1/schools/futo/faculties" \ |
| 2 | -H "Authorization: Bearer YOUR_API_KEY" |
JSON Response (200 OK)json
| 1 | { |
| 2 | "status": "success", |
| 3 | "message": "faculties_tree_retrieved", |
| 4 | "data": { |
| 5 | "school": { "id": "sch_futo_ng", "name": "Federal University of Technology, Owerri", "shortName": "FUTO" }, |
| 6 | "facultiesCount": 7, |
| 7 | "departmentsCount": 24, |
| 8 | "faculties": [ |
| 9 | { |
| 10 | "code": "SICT", |
| 11 | "name": "School of Information and Communication Technology", |
| 12 | "departments": [ |
| 13 | { "code": "CSC", "name": "Computer Science", "degrees": ["B.Tech", "M.Sc", "Ph.D"] }, |
| 14 | { "code": "SWE", "name": "Software Engineering", "degrees": ["B.Tech"] } |
| 15 | ] |
| 16 | } |
| 17 | ] |
| 18 | } |
| 19 | } |
Resolve Email Domain
GET
/v1/domains/resolvePass any student email address or domain suffix to immediately resolve the corresponding university.
Query Parameters
Parameter | Type | Description |
|---|---|---|
| domain | string | Domain string (e.g. futo.edu.ng or student.futo.edu.ng) |
| string | Or complete email (e.g. scholar@futo.edu.ng) |
cURL Requestbash
| 1 | curl -X GET "https://schools.syncnexa.co/v1/domains/resolve?domain=futo.edu.ng" \ |
| 2 | -H "Authorization: Bearer YOUR_API_KEY" |
JSON Response (200 OK)json
| 1 | { |
| 2 | "status": "success", |
| 3 | "message": "domain_resolved", |
| 4 | "data": { |
| 5 | "matchedDomain": "futo.edu.ng", |
| 6 | "school": { |
| 7 | "id": "sch_futo_ng", |
| 8 | "name": "Federal University of Technology, Owerri", |
| 9 | "short_name": "FUTO", |
| 10 | "slug": "futo", |
| 11 | "state": "Imo", |
| 12 | "portal_url": "https://portal.futo.edu.ng", |
| 13 | "syncid_enabled": true |
| 14 | } |
| 15 | } |
| 16 | } |