Groups
getGroups
Get groups list (with course)
GET /v2/groups
Requires authorization
Parameters:
| Key | Description |
|---|---|
branch_id | ID of branch |
page | Page number |
per_page | Number of items per page |
Response 200
| Key | Description |
|---|---|
id | ID of group |
name | Name of group |
days | Days of group. 1 = Mon,Wed,Fri. 2 = Tue,ThuSat. 3 =Sat,Sun. 4 = Every Day. 5 = Other (look at exact_days key) |
exact_days | Days of group. Only if days = 5. |
lesson_start_time | Lesson start time |
lesson_end_time | Lesson end time |
status | Status of group. 2 = Active, 3 = Archive |
course | Course of group. |
{
"status": 200,
"success": true,
"data": [
{
"id": 12920,
"company_group_number": 1,
"name": "Math-1",
"days": 2,
"exact_days": [],
"lesson_start_time": "2024-06-28T03:00:00.000000Z",
"lesson_end_time": "2024-06-28T04:30:00.000000Z",
"status": 2,
"type": 1,
"is_corporate": 0,
"salary_for_corporate": null,
"write_off": null,
"last_write_off_date": "2022-06-27",
"next_write_off_date": "2022-07-20",
"course_id": 941,
"branch_id": 147,
"selection_start_date": null,
"selection_end_date": null,
"group_start_date": "2022-05-01",
"group_end_date": "2023-06-01",
"created_at": "2022-05-30T06:29:27.000000Z",
"updated_at": "2023-08-18T09:51:04.000000Z",
"created_by": 22452,
"updated_by": 22452,
"deleted_at": null,
"deleted_by": null,
"comment": "This is comment by admin in student's profile",
"course": {
"id": 941,
"name": "Math",
"image": "https://api.modme.dev/uploads/EdSqx63bEpASBWBd.jpg",
"description": "Basic math operations, arithmetic.",
"lesson_duration": "90",
"course_duration": 12,
"is_enabled": 1,
"parent_id": null,
"price": 500000,
"company_id": 131,
"type": 2,
"lessons_per_module": 12,
"created_at": "2022-05-30T06:28:42.000000Z",
"updated_at": "2023-10-20T07:04:44.000000Z",
"created_by": 22452,
"updated_by": 9,
"deleted_at": null,
"deleted_by": null,
"short_name": null
}
}
],
"pagination": {
"count": 1,
"total": 340,
"perPage": 1,
"currentPage": 1,
"totalPages": 340,
"links": {
"next": "http://127.0.0.1:8000/v2/groups?branch_id=147&per_page=1&page=2"
}
}
}