Group
Search Groups
Search for Groups with filtering capabilities.
post/group/_search
Query parameters
limitinteger
Example:1
The maximum number of Groups to return (default: 50) when searching Groups
offsetinteger
The number of Groups to skip before starting to return results (default: 0) when searching Groups
Request body
Example request
{
"filter": {
"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,
"nestedFilters": [
{
"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
Example response
{
"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": {
"limit": 1,
"total": 100
}
}