from meitner import Meitner, models
from meitner.utils import parse_datetime
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.search(filter_={
"equals": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_by": "123e4567-e89b-12d3-a456-426614174000",
},
"external": {
"source_id": "example",
"source": "example",
},
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"title": "example",
"moderator_i_ds": "123e4567-e89b-12d3-a456-426614174000",
"member_i_ds": "123e4567-e89b-12d3-a456-426614174000",
},
"not_equals": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_by": "123e4567-e89b-12d3-a456-426614174000",
},
"external": {
"source_id": "example",
"source": "example",
},
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"title": "example",
"moderator_i_ds": "123e4567-e89b-12d3-a456-426614174000",
"member_i_ds": "123e4567-e89b-12d3-a456-426614174000",
},
"greater_than": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
},
"smaller_than": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
},
"greater_or_equal": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
},
"smaller_or_equal": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
},
"contains": {
"id": [
"123e4567-e89b-12d3-a456-426614174000",
],
"meta": {
"created_by": [
"123e4567-e89b-12d3-a456-426614174000",
],
"updated_by": [
"123e4567-e89b-12d3-a456-426614174000",
],
},
"external": {
"source_id": [
"example",
],
"source": [
"example",
],
},
"school_id": [
"123e4567-e89b-12d3-a456-426614174000",
],
"title": [
"example",
],
"moderator_i_ds": [
"123e4567-e89b-12d3-a456-426614174000",
],
"member_i_ds": [
"123e4567-e89b-12d3-a456-426614174000",
],
},
"not_contains": {
"id": [
"123e4567-e89b-12d3-a456-426614174000",
],
"meta": {
"created_by": [
"123e4567-e89b-12d3-a456-426614174000",
],
"updated_by": [
"123e4567-e89b-12d3-a456-426614174000",
],
},
"external": {
"source_id": [
"example",
],
"source": [
"example",
],
},
"school_id": [
"123e4567-e89b-12d3-a456-426614174000",
],
"title": [
"example",
],
"moderator_i_ds": [
"123e4567-e89b-12d3-a456-426614174000",
],
"member_i_ds": [
"123e4567-e89b-12d3-a456-426614174000",
],
},
"like": {
"external": {
"source_id": "example",
"source": "example",
},
"title": "example",
},
"not_like": {
"external": {
"source_id": "example",
"source": "example",
},
"title": "example",
},
"null": {
"meta": {
"created_by": True,
"updated_at": True,
"updated_by": True,
},
"external": {
"source_id": True,
"source": True,
},
"types": True,
"moderator_i_ds": True,
"member_i_ds": True,
},
"not_null": {
"meta": {
"created_by": True,
"updated_at": True,
"updated_by": True,
},
"external": {
"source_id": True,
"source": True,
},
"types": True,
"moderator_i_ds": True,
"member_i_ds": True,
},
"or_condition": True,
}, 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
}
}Search Groups
Search for Groups with filtering capabilities.
from meitner import Meitner, models
from meitner.utils import parse_datetime
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.search(filter_={
"equals": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_by": "123e4567-e89b-12d3-a456-426614174000",
},
"external": {
"source_id": "example",
"source": "example",
},
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"title": "example",
"moderator_i_ds": "123e4567-e89b-12d3-a456-426614174000",
"member_i_ds": "123e4567-e89b-12d3-a456-426614174000",
},
"not_equals": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_by": "123e4567-e89b-12d3-a456-426614174000",
},
"external": {
"source_id": "example",
"source": "example",
},
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"title": "example",
"moderator_i_ds": "123e4567-e89b-12d3-a456-426614174000",
"member_i_ds": "123e4567-e89b-12d3-a456-426614174000",
},
"greater_than": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
},
"smaller_than": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
},
"greater_or_equal": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
},
"smaller_or_equal": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
},
"contains": {
"id": [
"123e4567-e89b-12d3-a456-426614174000",
],
"meta": {
"created_by": [
"123e4567-e89b-12d3-a456-426614174000",
],
"updated_by": [
"123e4567-e89b-12d3-a456-426614174000",
],
},
"external": {
"source_id": [
"example",
],
"source": [
"example",
],
},
"school_id": [
"123e4567-e89b-12d3-a456-426614174000",
],
"title": [
"example",
],
"moderator_i_ds": [
"123e4567-e89b-12d3-a456-426614174000",
],
"member_i_ds": [
"123e4567-e89b-12d3-a456-426614174000",
],
},
"not_contains": {
"id": [
"123e4567-e89b-12d3-a456-426614174000",
],
"meta": {
"created_by": [
"123e4567-e89b-12d3-a456-426614174000",
],
"updated_by": [
"123e4567-e89b-12d3-a456-426614174000",
],
},
"external": {
"source_id": [
"example",
],
"source": [
"example",
],
},
"school_id": [
"123e4567-e89b-12d3-a456-426614174000",
],
"title": [
"example",
],
"moderator_i_ds": [
"123e4567-e89b-12d3-a456-426614174000",
],
"member_i_ds": [
"123e4567-e89b-12d3-a456-426614174000",
],
},
"like": {
"external": {
"source_id": "example",
"source": "example",
},
"title": "example",
},
"not_like": {
"external": {
"source_id": "example",
"source": "example",
},
"title": "example",
},
"null": {
"meta": {
"created_by": True,
"updated_at": True,
"updated_by": True,
},
"external": {
"source_id": True,
"source": True,
},
"types": True,
"moderator_i_ds": True,
"member_i_ds": True,
},
"not_null": {
"meta": {
"created_by": True,
"updated_at": True,
"updated_by": True,
},
"external": {
"source_id": True,
"source": True,
},
"types": True,
"moderator_i_ds": True,
"member_i_ds": True,
},
"or_condition": True,
}, 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 searching Groups
The number of Groups to skip before starting to return results (default: 0) when searching Groups
Body
Request body
Filter criteria to search for specific records
Show child attributes
Show child attributes
OrCondition decides if this filter is within an OR-condition or AND-condition
Equality filters for Group
Show child attributes
Show child attributes
Unique identifier for the Group
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": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}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": "example",
"source": "example"
}The ID of the school the group belongs to
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 The title of the group, must be unique within the school.
The types 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.
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
},
"external": {
"sourceID": "example",
"source": "example"
},
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"title": "example",
"moderatorIDs": "123e4567-e89b-12d3-a456-426614174000",
"memberIDs": "123e4567-e89b-12d3-a456-426614174000"
}Inequality filters for Group
Show child attributes
Show child attributes
Unique identifier for the Group
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": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}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": "example",
"source": "example"
}The ID of the school the group belongs to
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 The title of the group, must be unique within the school.
The types 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.
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
},
"external": {
"sourceID": "example",
"source": "example"
},
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"title": "example",
"moderatorIDs": "123e4567-e89b-12d3-a456-426614174000",
"memberIDs": "123e4567-e89b-12d3-a456-426614174000"
}Greater than filters for Group
Show child attributes
Show child attributes
Metadata information for the Group
{
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}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.
{
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
}Smaller than filters for Group
Show child attributes
Show child attributes
Metadata information for the Group
{
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}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.
{
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
}Greater than or equal filters for Group
Show child attributes
Show child attributes
Metadata information for the Group
{
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}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.
{
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
}Smaller than or equal filters for Group
Show child attributes
Show child attributes
Metadata information for the Group
{
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}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.
{
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
}Contains filters for Group
Show child attributes
Show child attributes
Unique identifier for the Group
Metadata information for the Group
{
"createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
"updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
}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": ["example"],
"source": ["example"]
}The ID of the school the group belongs to
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.
The category of the group
Education, Other The title of the group, must be unique within the school.
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.
{
"id": ["123e4567-e89b-12d3-a456-426614174000"],
"meta": {
"createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
"updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
},
"external": {
"sourceID": ["example"],
"source": ["example"]
},
"schoolID": ["123e4567-e89b-12d3-a456-426614174000"],
"title": ["example"],
"moderatorIDs": ["123e4567-e89b-12d3-a456-426614174000"],
"memberIDs": ["123e4567-e89b-12d3-a456-426614174000"]
}Not contains filters for Group
Show child attributes
Show child attributes
Unique identifier for the Group
Metadata information for the Group
{
"createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
"updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
}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": ["example"],
"source": ["example"]
}The ID of the school the group belongs to
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.
The category of the group
Education, Other The title of the group, must be unique within the school.
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.
{
"id": ["123e4567-e89b-12d3-a456-426614174000"],
"meta": {
"createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
"updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
},
"external": {
"sourceID": ["example"],
"source": ["example"]
},
"schoolID": ["123e4567-e89b-12d3-a456-426614174000"],
"title": ["example"],
"moderatorIDs": ["123e4567-e89b-12d3-a456-426614174000"],
"memberIDs": ["123e4567-e89b-12d3-a456-426614174000"]
}LIKE filters for Group
Show child attributes
Show child attributes
Metadata information for the Group
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": "example",
"source": "example"
}The title of the group, must be unique within the school.
{
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example"
}NOT LIKE filters for Group
Show child attributes
Show child attributes
Metadata information for the Group
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": "example",
"source": "example"
}The title of the group, must be unique within the school.
{
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example"
}Null filters for Group
Show child attributes
Show child attributes
Metadata information for the Group
{
"createdBy": true,
"updatedAt": true,
"updatedBy": true
}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": true, "source": true }The types of the group
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.
{
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": { "sourceID": true, "source": true },
"types": true,
"moderatorIDs": true,
"memberIDs": true
}Not null filters for Group
Show child attributes
Show child attributes
Metadata information for the Group
{
"createdBy": true,
"updatedAt": true,
"updatedBy": true
}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": true, "source": true }The types of the group
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.
{
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": { "sourceID": true, "source": true },
"types": true,
"moderatorIDs": true,
"memberIDs": true
}NestedFilters of the Group, useful for more complex filters
{
"equals": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
},
"external": {
"sourceID": "example",
"source": "example"
},
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"title": "example",
"moderatorIDs": "123e4567-e89b-12d3-a456-426614174000",
"memberIDs": "123e4567-e89b-12d3-a456-426614174000"
},
"notEquals": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
},
"external": {
"sourceID": "example",
"source": "example"
},
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"title": "example",
"moderatorIDs": "123e4567-e89b-12d3-a456-426614174000",
"memberIDs": "123e4567-e89b-12d3-a456-426614174000"
},
"greaterThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"smallerThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"greaterOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"smallerOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"contains": {
"id": ["123e4567-e89b-12d3-a456-426614174000"],
"meta": {
"createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
"updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
},
"external": {
"sourceID": ["example"],
"source": ["example"]
},
"schoolID": ["123e4567-e89b-12d3-a456-426614174000"],
"title": ["example"],
"moderatorIDs": ["123e4567-e89b-12d3-a456-426614174000"],
"memberIDs": ["123e4567-e89b-12d3-a456-426614174000"]
},
"notContains": {
"id": ["123e4567-e89b-12d3-a456-426614174000"],
"meta": {
"createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
"updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
},
"external": {
"sourceID": ["example"],
"source": ["example"]
},
"schoolID": ["123e4567-e89b-12d3-a456-426614174000"],
"title": ["example"],
"moderatorIDs": ["123e4567-e89b-12d3-a456-426614174000"],
"memberIDs": ["123e4567-e89b-12d3-a456-426614174000"]
},
"like": {
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example"
},
"notLike": {
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example"
},
"null": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": { "sourceID": true, "source": true },
"types": true,
"moderatorIDs": true,
"memberIDs": true
},
"notNull": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": { "sourceID": true, "source": true },
"types": true,
"moderatorIDs": true,
"memberIDs": true
},
"orCondition": true
}Response
Response for Group Search operation - returns filtered Group results
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 }