Open Education API Groups API

The groups API provides information about groups that are related to organisations, persons and offerings. Groups of students that are related to an offering are typically used for rostering. The rostering application assigns students based on these groups. For example, class 1b will be assigned to the course offering on Monday morning. Not all groups are related to an offering. A group of people can also be a team that is working on a task outside the scope of the OEAPI. These can be teams of students, but also teams of employees.

Operations 11

GET /course-offerings/{courseOfferingId}/groups GET /course-offerings/{courseOfferingId}/groups #
GET /groups GET /groups #
GET /groups/{groupId} GET /groups/{groupId} #
PUT /groups/{groupId} PUT /groups/{groupId} #
GET /groups/{groupId}/memberships GET /groups/{groupId}/memberships #
PUT /groups/{groupId}/memberships/{personId} PUT /groups/{groupId}/memberships/{personId} #
GET /learning-component-offerings/{learningComponentOfferingId}/groups GET /learning-component-offerings/{learningComponentOfferingId}/groups #
GET /organisations/{organisationId}/groups GET /organisations/{organisationId}/groups #
GET /programme-offerings/{programmeOfferingId}/groups GET /programme-offerings/{programmeOfferingId}/groups #
GET /test-component-offerings/{testComponentOfferingId}/groups GET /test-component-offerings/{testComponentOfferingId}/groups #
GET /groups/{groupId}/persons GET /groups/{groupId}/persons #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/json-schema/open-education-api-test-component-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/json-schema/open-education-api-learning-component-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/json-schema/open-education-api-person-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/json-schema/open-education-api-learning-outcome-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/json-schema/open-education-api-organisation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/json-schema/open-education-api-academic-session-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/json-schema/open-education-api-component-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/json-schema/open-education-api-organization-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/json-schema/open-education-api-room-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/json-schema/open-education-api-group-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/open-education-api:open-education-api-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

open-education-api-groups-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Open Education Groups API
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged groups across 3 of this provider''s published API definitions: oeapi-6.0-rc.3.yaml, ooapi-v5.yaml, open-education-api-v5-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://demo01.eduapi.nl/v6
  description: SURF demo implementation
- url: http://demo01.eduapi.nl/v5
  description: SURF demo implementation
tags:


# --- truncated at 32 KB (132 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/openapi/open-education-api-groups-api-openapi.yml