Skip to main content
GET
/
v1
/
console
/
students
List Students
curl --request GET \
  --url http://localhost:8000/v1/console/students \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "status": "<string>",
      "student_email": "<string>",
      "student_name": "<string>",
      "user_id": "<string>",
      "last_seen": "2023-11-07T05:31:56Z",
      "overall_case_studies": 0,
      "programme_label": "",
      "programmes": []
    }
  ],
  "page": 123,
  "page_size": 123,
  "total": 123,
  "total_pages": 123,
  "message": "<string>",
  "success": true
}

Authorizations

Authorization
string
header
required

Enter your JWT access token

Query Parameters

search
string | null
programme
string | null

Programme code

status
string | null

active or inactive

start_date
string<date-time> | null

Filter by last-seen from

end_date
string<date-time> | null

Filter by last-seen to

sort_by
string
default:last_seen

name, last_seen, programme, or status

sort_order
string
default:desc
skip
integer
default:0
Required range: x >= 0
limit
integer
default:10
Required range: 1 <= x <= 100

Response

Successful Response

data
StudentListItem · object[]
required
page
integer
required
page_size
integer
required
total
integer
required
total_pages
integer
required
message
string | null
success
boolean
default:true