aid: open-education-api

name: Open Education API

description: 'The Open Education API (OEAPI, formerly OOAPI) is an open REST API standard for exchanging education data — institutions, programmes,
  courses, offerings, persons and results — between educational institutions, students and suppliers. It was created by a community of Dutch universities,
  colleges (MBO, HBO, WO) and suppliers, facilitated by SURF and supported via the Npuls programme. OEAPI is a specification rather than a hosted,
  queryable API: institutions implement their own endpoints from the published OpenAPI specification, with use cases including RIO and eduXchange.
  Source: https://oeapi.eu/ (fetched 2026-10-09).'

url: https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/apis.yml

x-type: company

x-source: harvest:spectral-ruleset-github

x-tier: profiled
x-tier-reason: enrichment pass 2026-10-09 (modular-v1; was harvest)

specificationVersion: '0.20'

created: '2026-10-09'

modified: '2026-10-09'

tags:
- Company
- Education
- Higher Education
- Open Standards
- Interoperability
- Specifications
- Netherlands

maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
- FN: APIs.json
  email: info@apis.io

image: https://oeapi.eu/v6.0/_media/OpenEducationApi_Logo.png

common:
- type: AgenticAccess
  url: agentic-access/open-education-api-agentic-access.yml
- type: Spectral
  url: rules/open-education-api-specification-spectral-rules.yml
- type: Spectral
  url: rules/open-education-api-rules.yml
- type: JSONLD
  url: json-ld/open-education-api-context.jsonld
- type: Vocabulary
  url: vocabulary/open-education-api-vocabulary.yml
- type: AgentSkill
  url: skills/_index.yml
- type: DataModel
  url: data-model/open-education-api-data-model.yml
- type: ChangeLog
  url: changelog/open-education-api-changelog.yml
- type: Conventions
  url: conventions/open-education-api-conventions.yml
- type: Deprecation
  url: lifecycle/open-education-api-lifecycle.yml
- type: Lifecycle
  url: lifecycle/open-education-api-lifecycle.yml
- type: ErrorCatalog
  url: errors/open-education-api-problem-types.yml
- type: Conformance
  url: conformance/open-education-api-conformance.yml
- type: Overlay
  url: overlays/open-education-api-open-education-api-overlay.yaml
- type: Hosts
  url: hosts/open-education-api-hosts.yml
- type: Vendors
  url: vendors/open-education-api-vendors.yml
- type: SDKs
  url: packages/open-education-api-packages.yml
- type: Packages
  url: packages/open-education-api-packages.yml
- type: Authentication
  url: authentication/open-education-api-authentication.yml
- type: DomainSecurity
  url: security/open-education-api-domain-security.yml
- type: Website
  url: https://oeapi.eu/
- type: Documentation
  url: https://oeapi.eu/v6.0/
- type: APIReference
  url: https://oeapi.eu/specification/v6.0/
- type: GettingStarted
  url: https://oeapi.eu/v6.0/#/introduction/get-started
- type: ChangeLog
  url: https://oeapi.eu/v6.0/#/changelog/CHANGELOG
- type: Support
  url: https://oeapi.eu/v6.0/#/contact
- type: MailingList
  url: https://list.surf.nl/postorius/lists/oeapi.list.surf.nl
- type: GitHubOrganization
  url: https://github.com/open-education-api
- type: GitHubRepository
  url: https://github.com/open-education-api/specification
- type: SpectralRules
  url: https://github.com/open-education-api/specification/blob/32baca313e05299d6d15333622679812a80b2d9b/.spectral.yaml

apis:
- aid: open-education-api:open-education-api-academic-sessions-api
  name: Open Education API academic sessions API
  description: >-
    The academic sessions API provides information about the different time periods

    a programme can be offered.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - academic sessions
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-academic-sessions-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-associations-api
  name: Open Education API Associations API
  description: "The associations API provides information about the association between an offering and\
    \ a person (e.g. students, lecturers, etc).\nAssociations can be posted between institutions This\
    \ requires information details on the offering and the persons.\nTo allow for this information a complete\
    \ person object and offering object can be part of the API.\nThe structure is explained in the following\
    \ model:\n<table>\n  <tr>\n   <td></td>\n   <td colspan=3 align=center>offering</td>\n  </tr>\n  <tr>\n\
    \   <td rowspan=3>student</td>\n   <td></td>\n   <!-- <td>internal</td>\n   -->\n   <td>external</td>\n\
    \  </tr>\n  <tr>\n   <td>internal</td>\n   <!-- <td>POST <a href=\"#tag/offerings/paths/~1offerings~1{offeringId}~1associations~1external/post\"\
    >/offerings/{offeringId}/associations/me</a> local enrollment based on selected offering\n    This\
    \ call will allow for a local student using his .wellknown credentials to enroll for the offering\
    \ identified by the offeringId\n    <br>Alternatively the association can also be created through\
    \ POST <a href=\"#tag/associations/paths/~1associations~1me/post\">/associations/me</a>\n   </td>\n\
    \   -->\n   <td>POST <a href=\"#tag/associations/paths/~1associations~1external~1me/post\">/associations/external/me</a>\
    \ gets student details from .wellknown at home institution. It passes offering details (provided by\
    \ external institution) to the home institution so the home institution can create a placeholder for\
    \ the offering and its results. \n   </td>\n  </tr>\n  <tr>\n   <td>external</td>\n    <!--\n    <td>\n\
    \    This method is not yet implemented it requires full student details and offering details. This\
    \ would mean the \n    OOAPI message would contain more than one resource in the message. At the moment\
    \ the student mobility project is looking into\n    a sollution.\n    <br> Alternatively it could\
    \ be achieved through using two calls:\n    <ul>\n     <li>create student with POST <a href=\"#tag/persons/paths/~1persons~1{personId}/post\"\
    >/persons</a></li>\n     <li><a href=\"#tag/offerings/paths/~1offerings~1{offeringId}~1associations~1external/post\"\
    >/offerings/{offeringId}/associations/me</a></li>\n    </ul>\n    for the enrollment\n   </td>\n \
    \   -->\n   <td>no support needed</td>\n  </tr>\n</table>\nDirect update of current information: <a\
    \ href=\"#tag/associations/paths/~1associations~1{associationId}/patch\"> PATCH /associations/{associationId}</a>\n\
    This call is currently limited to passing results and a remote state. For future use other association\
    \ resource information could be passed. \nMore information on the support for student mobility can\
    \ be found \n<a href=\"https://swimlanes.io/d/s5mfpj7Si\">here</a>"
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - associations
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-associations-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-buildings-api
  name: Open Education API Buildings API
  description: >-
    The building API provides a building that is currently used by the organisation.

    It includes all location details.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - buildings
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-buildings-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-components-api
  name: Open Education API Components API
  description: The components API provides information about components being part of parent courses.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - components
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-components-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-course-offering-associations-api
  name: Open Education API course offering associations API
  description: "The course offering associations API provides information about the association\nbetween\
    \ a course offering and a person (e.g. students, lecturers, etc).\nAssociations can be posted between\
    \ institutions. This requires detailed information\non the course offering and the persons. To allow\
    \ for this information a\ncomplete person object and offering object can be part of the API. The structure\n\
    is explained in the following model:\n<table>\n  <tr>\n   <td></td>\n   <td colspan=3 align=center>offering</td>\n\
    \  </tr>\n  <tr>\n   <td rowspan=3>student</td>\n   <td></td>\n   <!-- <td>internal</td>\n   -->\n\
    \   <td>external</td>\n  </tr>\n  <tr>\n   <td>internal</td>\n   <td>POST <a\n     href=\"#tag/course-offering-associations/operation/createExternalCourseOfferingAssociationByopenId\"\
    >\n     /course-offering-associations/external/me</a>Retrieves student details from the well known\
    \ endpoint \n     that exposes person information at the home institution.\n     It passes offering\
    \ details (provided by\n     external institution) to the home institution so the home institution\
    \ can\n     create a placeholder for the offering and its results.\n   </td>\n  </tr>\n  <tr>\n  \
    \ <td>external</td>\n   <td>no support needed</td>\n  </tr>\n</table>\nDirect update of current information:\
    \ <a\n  href=\"#tag/course-offering-associations/operation/partialUpdateCourseOfferingAssociationById\"\
    >\n  PATCH /course-offering-associations/{courseOfferingAssociationId}</a>\nThis call is currently\
    \ limited to passing results and a remote state. For future\nuse other association resource information\
    \ could be passed. More information on\nthe support for student mobility can be found\n<a href=\"\
    https://swimlanes.io/d/s5mfpj7Si\">here</a>"
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - course offering associations
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-course-offering-associations-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-course-offerings-api
  name: Open Education API course offerings API
  description: >-
    The offerings API provides information about offerings which have a global

    timeframe, e.g. a period to which students can enrol.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - course offerings
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-course-offerings-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-courses-api
  name: Open Education API Courses API
  description: >-
    The courses API provides a self-contained and formally structured learning experience,

    aimed at delivering defined learning outcomes to students, usually within the context

    of a programme.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - courses
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-courses-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-documents-api
  name: Open Education API Documents API
  description: The API for accessing and retrieving document resources.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - documents
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-documents-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-education-specifications-api
  name: Open Education API education specifications API
  description: >-
    The education specification API provides information on the specification of an education object.

    This specification allows for other education objects to be derived from it.

    It is used to aggregate education objects from a supplying institution.

    It clusters programs to a main educationSpecification that is used in registries such as RIO.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - education specifications
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-education-specifications-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-groups-api
  name: Open Education API Groups API
  description: "The groups API provides information about groups that are related to\norganisations, persons\
    \ and offerings. Groups of students that are related to an\noffering are typically used for rostering.\
    \ The rostering application assigns\nstudents based on these groups. For example, class 1b will be\
    \ assigned to the\ncourse offering on Monday morning. Not all groups are related to an offering. A\n\
    group of people can also be a team that is working on a task outside the \nscope of the OEAPI. These\
    \ can be teams of students, but also teams of employees."
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - groups
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-groups-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-learning-component-offering-associations-api
  name: Open Education API learning component offering associations API
  description: The API for associations between persons and learning component offerings.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - learning component offering associations
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-learning-component-offering-associations-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-learning-component-offerings-api
  name: Open Education API learning component offerings API
  description: "The offerings API provides information about learning component offerings which \nhave\
    \ a global timeframe, e.g. a period to which students can enrol."
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - learning component offerings
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-learning-component-offerings-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-learning-components-api
  name: Open Education API learning components API
  description: >-
    The learning components API provides information about learning activities that

    are part of a course (or learning component).
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - learning components
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-learning-components-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-learning-outcomes-api
  name: Open Education API learning outcomes API
  description: >-
    The learning outcomes API provides information about the statements regarding

    what a learner knows, understands and is able to do on completion of a learning

    process, which are defined in terms of knowledge, skills and responsibility and

    autonomy.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - learning outcomes
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-learning-outcomes-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-news-api
  name: Open Education API News API
  description: The news API provides news feeds and items regarding a specific subject.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - news
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-news-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-offerings-api
  name: Open Education API Offerings API
  description: >-
    The offerings API provides information about offerings which have a global timeframe, e.g. a period
    to which students can enroll.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - offerings
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-offerings-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-organisations-api
  name: Open Education API Organisations API
  description: >-
    The organisations API provides the organisations that are responsible for the

    execution and recognition of education, either as an educational institution or

    as an organisation providing services, internships or facilities.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - organisations
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-organisations-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-organizations-api
  name: Open Education API Organizations API
  description: >-
    The organizations API provides the organizations that are responsible for the execution and recognition
    of education.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - organizations
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-organizations-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-persons-api
  name: Open Education API Persons API
  description: The persons API provides information about persons related to an organisation.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - persons
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-persons-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-programme-offering-associations-api
  name: Open Education API programme offering associations API
  description: "The programme offering associations API provides information about the association\nbetween\
    \ a programme offering and a person (e.g. students, lecturers, etc).\nAssociations can be posted between\
    \ institutions. This requires detailed information\non the programme offering and the persons. To\
    \ allow for this information a\ncomplete person object and offering object can be part of the API.\
    \ The structure\nis explained in the following model:\n<table>\n  <tr>\n   <td></td>\n   <td colspan=3\
    \ align=center>offering</td>\n  </tr>\n  <tr>\n   <td rowspan=3>student</td>\n   <td></td>\n   <!--\
    \ <td>internal</td>\n   -->\n   <td>external</td>\n  </tr>\n  <tr>\n   <td>internal</td>\n   <!--\
    \ <td>POST <a\n        href=\"#tag/offerings/paths/~1offerings~1{offeringId}~1associations~1external/post\"\
    >\n        /offerings/{offeringId}/associations/me</a> local enrolment based on\n        selected\
    \ offering\n        This call will allow for a local student using his well known credentials\n  \
    \      to enrol for the offering identified by the offeringId\n        <br>Alternatively the association\
    \ can also be created through POST\n        <a href=\"#tag/associations/paths/~1associations~1me/post\"\
    >/associations/me</a>\n       </td>\n   -->\n   <td>POST <a\n     href=\"#tag/course-offering-associations/operation/createExternalProgrammeOfferingAssociationByopenId\"\
    >\n     /programme-offering-associations/external/me</a>Retrieves student details from the well known\
    \ endpoint \n     that exposes person information at the home institution.\n     It passes offering\
    \ details (provided by\n     external institution) to the home institution so the home institution\
    \ can\n     create a placeholder for the offering and its results.\n   </td>\n  </tr>\n  <tr>\n  \
    \ <td>external</td>\n    <!--\n    <td>\n    This method is not yet implemented it requires full student\
    \ details and\n    offering details. This would mean the OEAPI message would contain more than\n \
    \   one resource in the message. At the moment the student mobility project is\n    looking into a\
    \ solution.\n    <br> Alternatively it could be achieved through using two calls:\n    <ul>\n    \
    \ <li>create student with POST\n         <a href=\"#tag/persons/paths/~1persons~1{personId}/post\"\
    >/persons</a>\n     </li>\n     <li>\n         <a href=\"#tag/offerings/paths/~1offerings~1{offeringId}~1associations~1external/post\"\
    >\n         /offerings/{offeringId}/associations/me</a>\n     </li>\n    </ul>\n    for the enrolment\n\
    \   </td>\n    -->\n   <td>no support needed</td>\n  </tr>\n</table>\nDirect update of current information:\
    \ <a\n  href=\"#tag/programme-offering-associations/operation/partialUpdateProgrammeOfferingAssociationById\"\
    >\n  PATCH /programme-offering-associations/{programmeOfferingAssociationId}</a>\nThis call is currently\
    \ limited to passing results and a remote state. For future\nuse other association resource information\
    \ could be passed. More information on\nthe support for student mobility can be found\n<a href=\"\
    https://swimlanes.io/d/s5mfpj7Si\">here</a>"
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - programme offering associations
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-programme-offering-associations-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-programme-offerings-api
  name: Open Education API programme offerings API
  description: "The offerings API provides information about programme offerings which have a \nglobal\
    \ timeframe, e.g. a period to which students can enrol."
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - programme offerings
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-programme-offerings-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-programmes-api
  name: Open Education API Programmes API
  description: >-
    The programmes API provides a coherent set of educational components, aimed at the

    realisation of competences or objectives in the field of knowledge, insight,

    attitudes and skills that the person who completes the programme must have.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - programmes
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-programmes-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-programs-api
  name: Open Education API Programs API
  description: >-
    The programs API provides a coherent set of educational components, aimed at the realization of competences
    or objectives in the field of knowledge, insight, attitudes and skills that the person who completes
    the program must have.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - programs
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-programs-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-rooms-api
  name: Open Education API Rooms API
  description: >-
    The rooms API provides the part of a building where an activity can take place.

    Including detailed information on the resources available, number of seats, etc.

    (Updated continuously)
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - rooms
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-rooms-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-service-metadata-api
  name: Open Education API service metadata API
  description: >-
    The service API provides additional metadata needed to make the OEAPI fit for

    this organisation.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - service metadata
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-service-metadata-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-test-component-offering-association-attempts-api
  name: Open Education API test component offering association attempts API
  description: >-
    The API for the attempts that are made by a person on a test component offering association.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - test component offering association attempts
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-test-component-offering-association-attempts-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-test-component-offering-associations-api
  name: Open Education API test component offering associations API
  description: The API for associations between persons and test component offerings.
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - test component offering associations
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-test-component-offering-associations-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-test-component-offerings-api
  name: Open Education API test component offerings API
  description: "The offerings API provides information about test component offerings which \nhave a global\
    \ timeframe, e.g. a period to which students can enrol."
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - test component offerings
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-test-component-offerings-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
- aid: open-education-api:open-education-api-test-components-api
  name: Open Education API test components API
  description: >-
    The test components API provides information about test or assessment activities

    that are part of a course (or learning unit).
  humanURL: https://oeapi.eu/specification/v6.0/
  tags:
  - test components
  properties:
  - type: OpenAPI
    url: openapi/open-education-api-test-components-api-openapi.yml
  - type: Documentation
    url: https://oeapi.eu/v6.0/
  - type: JSONSchema
    url: json-schema/open-education-api-test-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-person-properties-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-learning-outcome-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organisation-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-academic-session-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-component-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-organization-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-room-schema.json
  - type: JSONSchema
    url: json-schema/open-education-api-group-schema.json
x-enrichment:
  date: '2026-10-09'
  status: enriched
  artifacts_added: 42
  pass: modular-v1
  engine: identity=anthropic,contract=anthropic,surfaces=anthropic,docs=anthropic,regulatory=anthropic
x-coverage:
  state: covered
  reason: identity-verified
  detail: 'Enriched 2026-10-09: website and identity verified (verified) from the provider''s own pages; probed URLs below.'
  evidence:
  - url: https://oeapi.eu/
    status: 200
  - url: https://oeapi.eu/specification/v6.0/
    status: 200
  - url: https://oeapi.eu/v6.0/contact.md
    status: 200
  - url: https://oeapi.eu/v6.0/introduction/get-started.md
    status: 200
  - url: https://oeapi.eu/v6.0/changelog/CHANGELOG.md
    status: 200
  - url: https://github.com/open-education-api
    status: 200
  - url: https://list.surf.nl/postorius/lists/oeapi.list.surf.nl
    status: 200
  - url: https://oeapi.eu/v6.0/_media/OpenEducationApi_Logo.png
    status: 200