from meitner import Meitner, models
import os
with Meitner(
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = m_client.groups.list(limit=1, offset=0)
while res is not None:
# Handle items
res = res.next(){
"data": [
{
"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",
"category": "Education",
"title": "1A",
"types": [
"Class"
],
"moderatorIDs": [
"123e4567-e89b-12d3-a456-426614174000"
],
"memberIDs": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"pagination": {
"offset": 0,
"limit": 1,
"total": 100
}
}List Groups
Returns a paginated list of all Groups in your organization.
from meitner import Meitner, models
import os
with Meitner(
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = m_client.groups.list(limit=1, offset=0)
while res is not None:
# Handle items
res = res.next(){
"data": [
{
"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",
"category": "Education",
"title": "1A",
"types": [
"Class"
],
"moderatorIDs": [
"123e4567-e89b-12d3-a456-426614174000"
],
"memberIDs": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"pagination": {
"offset": 0,
"limit": 1,
"total": 100
}
}Query Parameters
The maximum number of Groups to return (default: 50) when listing Groups
The number of Groups to skip before starting to return results (default: 0) when listing Groups
Response
Response for Group List operation - returns a paginated list of Group
Array of Group objects
Show child attributes
Show child attributes
Unique identifier for the Group
The ID of the school the group belongs to
The title of the group, must be unique within the school.
Metadata information for the Group
Show child attributes
Show child attributes
Timestamp when the resource was created
User who created the resource
Timestamp when the resource was last updated
User who last updated the resource
{
"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 is a reusable object that can be used to store external information about the employee from another system, used for third-party integration tracking.
{
"sourceID": "12345678",
"source": "ExternalIntegrationAPI"
}If the category is Education, the ModeratorIDs have to be employees and the MemberIDs have to be students of the school. If the category is Other, it will not be possible to use the IsClass, IsChildcare and IsMentor fields.
Education, Other "Education"
The types of the group
The type of the group
Class, Childcare, Mentor 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.
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.
Pagination information
{ "offset": 0, "limit": 1, "total": 100 }