Sign in

v2

latestOpenAPI 3.1.0Proprietary - Licensed to Authorized Customers Only2026-07-31611061.1 MB
Group

Create a new Group

Create a new Group

post/group

Request body

schoolIDstring uuid required

The ID of the school the group belongs to

category'Education' | 'Other'

The category of the group

titlestring required

The title of the group, must be unique within the school.

typesGroupType[]

The types of the group. A group can have multiple types simultaneously. For preschools (FS), Class and Childcare types are automatically paired - adding Class will automatically include Childcare, and vice versa. Integration note for Mentor type - when importing groups from external systems, it can be difficult to determine whether a group should have the Mentor type. One recommended approach is to not include the Mentor type when creating or updating groups via the API, allowing school administrators to manually configure the Mentor type in Meitner as needed. When updating a group, you can preserve existing types by reading the current group state first and only modifying the specific types your integration manages (e.g., Class, Childcare). This ensures the Mentor type remains under administrator control.

moderatorIDsstring[]

The IDs of the moderators of the group. Can be any user type (Student, Employee, Guardian) if the Category is Other. If the Category is Education, the Moderators have to be employees of the school.

memberIDsstring[]

The IDs of the members of the group. Can be any user type (Student, Employee, Guardian) if the Category is Other. If the Category is Education, the Members have to be students of the school.

Example request

{
  "external": {
    "sourceID": "12345678"
  },
  "schoolID": "123e4567-e89b-12d3-a456-426614174000",
  "title": "1A",
  "types": [
    "Class"
  ],
  "moderatorIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "memberIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Response

Response for Group Create operation - returns the created Group

idstring uuid required

Unique identifier for the Group

schoolIDstring uuid required

The ID of the school the group belongs to

category'Education' | 'Other'

The category of the group

titlestring required

The title of the group, must be unique within the school.

typesGroupType[]

The types of the group. A group can have multiple types simultaneously. For preschools (FS), Class and Childcare types are automatically paired - adding Class will automatically include Childcare, and vice versa. Integration note for Mentor type - when importing groups from external systems, it can be difficult to determine whether a group should have the Mentor type. One recommended approach is to not include the Mentor type when creating or updating groups via the API, allowing school administrators to manually configure the Mentor type in Meitner as needed. When updating a group, you can preserve existing types by reading the current group state first and only modifying the specific types your integration manages (e.g., Class, Childcare). This ensures the Mentor type remains under administrator control.

moderatorIDsstring[]

The IDs of the moderators of the group. Can be any user type (Student, Employee, Guardian) if the Category is Other. If the Category is Education, the Moderators have to be employees of the school.

memberIDsstring[]

The IDs of the members of the group. Can be any user type (Student, Employee, Guardian) if the Category is Other. If the Category is Education, the Members have to be students of the school.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
    "updatedAt": "2024-01-15T14:45:00Z",
    "updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
  },
  "external": {
    "sourceID": "12345678",
    "source": "ExternalIntegrationAPI"
  },
  "schoolID": "123e4567-e89b-12d3-a456-426614174000",
  "title": "1A",
  "types": [
    "Class"
  ],
  "moderatorIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "memberIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}