Open Education API · Schema

Service

A metadata set providing details on the provider of this OEAPI implementation

CompanyEducationHigher EducationOpen StandardInteroperabilitySpecificationNetherlands

Properties

Name Type Description
contactEmail string Contact e-mail address of the service owner
specification string URL of the API specification (YAML or JSON, compliant with [Open API Specification v3](https://github.com/OAI/OpenAPI-Specification/))
documentation stringnull URL of the API documentation, including general terms and privacy statement
supportedConsumers arraynull
supportedOperations arraynull
supportedExpands arraynull
ext object
View JSON Schema on GitHub

JSON Schema

open-education-api-service-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/open-education-api/json-schema/open-education-api-service-schema.json",
  "title": "Service",
  "description": "A metadata set providing details on the provider of this OEAPI implementation",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/open-education-api-service-metadata-api-openapi.yml#/components/schemas/Service",
  "type": "object",
  "required": [
    "contactEmail",
    "specification"
  ],
  "properties": {
    "contactEmail": {
      "type": "string",
      "description": "Contact e-mail address of the service owner",
      "format": "email",
      "maxLength": 256
    },
    "specification": {
      "type": "string",
      "description": "URL of the API specification (YAML or JSON, compliant with [Open API Specification v3](https://github.com/OAI/OpenAPI-Specification/))",
      "format": "uri",
      "maxLength": 2048
    },
    "documentation": {
      "type": [
        "string",
        "null"
      ],
      "description": "URL of the API documentation, including general terms and privacy statement",
      "format": "uri",
      "maxLength": 2048
    },
    "supportedConsumers": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "description": "Object for communicating data to a specific consumer (destination). This object has no relationship with the consumer query parameter.",
        "required": [
          "consumerKey",
          "version"
        ],
        "properties": {
          "consumerKey": {
            "description": "The key of the consumer (destination) for which this information is intended. See the consumer registry for more information.",
            "type": "string"
          },
          "version": {
            "description": "the version number of this consumer",
            "type": "string"
          }
        }
      }
    },
    "supportedOperations": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "description": "Object for communicating VERBS and endpoints that are supported by this implementation.",
        "required": [
          "verbs",
          "path"
        ],
        "properties": {
          "verbs": {
            "type": "array",
            "description": "The type of method or verb.",
            "items": {
              "type": "string",
              "enum": [
                "GET",
                "PUT",
                "PATCH",
                "POST"
              ]
            }
          },
          "path": {
            "description": "the path of the operation",
            "type": "string",
            "format": "uri-template",
            "maxLength": 2048
          }
        }
      }
    },
    "supportedExpands": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "description": "Object for communicating the expands and paths for which they are implemented.",
        "required": [
          "expandableObjects",
          "path"
        ],
        "properties": {
          "expandableObjects": {
            "description": "the objects that are expandable for a specific path",
            "type": "array",
            "items": {
              "$ref": "#/$defs/expandableObjects"
            }
          },
          "path": {
            "description": "the path of the operation",
            "type": "string",
            "format": "uri-template",
            "maxLength": 2048
          }
        }
      }
    },
    "ext": {
      "oneOf": [
        {
          "$ref": "#/$defs/Ext"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "$defs": {
    "Ext": {
      "type": "object",
      "description": "Object for additional non-standard attributes"
    },
    "expandableObjects": {
      "type": "string",
      "description": "The object that can be expanded for this path.\n  - academic_session: the academicSession object can be expanded.\n  - building: the building object can be expanded.\n  - child: the child object (which is an instance of the current object) can be expanded.\n  - children: a set of objects (which are an instance of the current object) can be expanded.\n  - coordinators: the person object indicating a coordinator can be expanded.\n  - instructors: the person object indicating an instructor can be expanded.\n  - course: the course object can be expanded.\n  - course_offering: the courseOffering object can be expanded.\n  - learning_component: the learningComponent object can be expanded.\n  - learning_component_offering: the learningComponentOffering object can be expanded.\n  - learning_outcome: the learningOutcome object can be expanded.\n  - learning_outcomes: the learningOutcomes in the array containing learningOutcome objects can be expanded.\n  - organisation: the organisation object can be expanded.\n  - parent: the parent object (which is an instance of the current object) can be expanded.\n  - person: the person object can be expanded.\n  - programme: the programme object can be expanded.\n  - programmes: the programmes in the array containing programme objects can be expanded.\n  - programme_offering: the programmeOffering object can be expanded.\n  - room: the room object can be expanded.\n  - rooms: the rooms in the array can be expanded.\n  - test_component: the testComponent object can be expanded.\n  - test_component_offering: the testComponentOffering object can be expanded.\n  - year: the academicSession object indicating the year can be expanded.\n",
      "x-ooapi-extensible-enum": [
        "academic_session",
        "building",
        "child",
        "children",
        "coordinators",
        "course",
        "course_offering",
        "instructors",
        "learning_component",
        "learning_component_offering",
        "learning_outcome",
        "learning_outcomes",
        "organisation",
        "parent",
        "parents",
        "person",
        "programme",
        "programmes",
        "programme_offering",
        "room",
        "rooms",
        "test_component",
        "test_component_offering",
        "year"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/open-education-api-service"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.