List group members
Changed onReturn a paginated list of members in a group. The authenticated user must be allowed to view the group. Use search and filterId to narrow results.
When the group's teachers_can_see_members is false, only owners get the list: teachers and students get 200 with an empty members array and total_count 0.
Request
- Base URLhttps://plagiarismcheck.org
- AuthAPI key in header X-API-TOKEN
Path parameters
Numeric group ID.
Query parameters
Optional text search filter. Matching fields depend on the endpoint, for example filename, member name, email, or transaction text.
Filter by member ID or member role, depending on the endpoint.
Page number for paginated endpoints. Defaults to 1 when omitted.
Number of records per page. Defaults to 30 when omitted.
Response
The request succeeded and returned paginated group members.
Example response
{
"success": true,
"data": {
"members": [
{
"id": 3132945,
"role": 2,
"limit": 100,
"created_at": 1512638171000,
"user": {
"id": 3132945,
"name": "John Doe",
"email": "student@example.com",
"created_at": 1512638171000,
"updated_at": 1512638171000,
"allowed_languages": [
"en"
],
"balance_type": 1,
"avatar": "https://randomuser.me/api/portraits/lego/1.jpg",
"is_email_verification_needed": true
}
}
]
},
"pagination": {
"last": 3,
"current": 1,
"num_items_per_page": 30,
"first": 1,
"page_count": 3,
"total_count": 67,
"page_range": 3,
"start_page": 1,
"end_page": 3,
"pages_in_range": [
1,
2,
3
],
"first_page_in_range": 1,
"lastPage_in_range": 3,
"current_item_count": 30,
"first_item_number": 1,
"last_item_number": 30
}
}Changes
- info
added the optional property
/to the response with the status
- info
- breaking
the
////response's property format changed fromemailto no format for status - info
added the optional property
////to the response with the status
- breaking