# Open Education API Groups API

**Canonical:** https://apis.io/apis/open-education-api/open-education-api-groups-api/  
**Provider:** Open Education API — https://apis.io/providers/open-education-api/  
**Base URL:** https://demo01.eduapi.nl/v6  
**Documentation:** https://oeapi.eu/specification/v6.0/

Open Education API Groups API is one of 29 APIs that [Open Education API](https://apis.io/providers/open-education-api/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 10 JSON Schema definitions. Tagged areas include groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 10 JSON Schemas.

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)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/open-education-api/refs/heads/main/openapi/open-education-api-groups-api-openapi.yml
- **Documentation** — https://oeapi.eu/v6.0/
- **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

## Other Open Education API APIs (12)

- [Open Education API academic sessions API](https://apis.io/apis/open-education-api/open-education-api-academic-sessions-api/)
- [Open Education API Associations API](https://apis.io/apis/open-education-api/open-education-api-associations-api/)
- [Open Education API Buildings API](https://apis.io/apis/open-education-api/open-education-api-buildings-api/)
- [Open Education API Components API](https://apis.io/apis/open-education-api/open-education-api-components-api/)
- [Open Education API course offering associations API](https://apis.io/apis/open-education-api/open-education-api-course-offering-associations-api/)
- [Open Education API course offerings API](https://apis.io/apis/open-education-api/open-education-api-course-offerings-api/)
- [Open Education API Courses API](https://apis.io/apis/open-education-api/open-education-api-courses-api/)
- [Open Education API Documents API](https://apis.io/apis/open-education-api/open-education-api-documents-api/)
- [Open Education API education specifications API](https://apis.io/apis/open-education-api/open-education-api-education-specifications-api/)
- [Open Education API learning component offering associations API](https://apis.io/apis/open-education-api/open-education-api-learning-component-offering-associations-api/)
- [Open Education API learning component offerings API](https://apis.io/apis/open-education-api/open-education-api-learning-component-offerings-api/)
- [Open Education API learning components API](https://apis.io/apis/open-education-api/open-education-api-learning-components-api/)

## Tags

groups

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/open-education-api/open-education-api-groups-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/open-education-api/.