Skip to main content
GET
/
api
/
v1
/
students
/
curl -X GET https://api.chessplay.io/api/v1/students/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "count": 25,
  "next": "https://api.chessplay.io/api/v1/students/?page=2",
  "previous": null,
  "results": [
    {
      "id": 123,
      "username": "FastMalamute",
      "email": "john.doe@example.com",
      "phone_number": "+1234567890",
      "first_name": "John",
      "last_name": "Doe",
      "public_report_id": "abc-123-def-456",
      "created": "2024-01-15T10:30:00Z"
    },
    {
      "id": 124,
      "username": "TalentedSnail",
      "email": "jane.smith@example.com",
      "phone_number": null,
      "first_name": "Jane",
      "last_name": "Smith",
      "public_report_id": "xyz-789-uvw-012",
      "created": "2024-01-16T14:20:00Z"
    }
  ]
}

​
Authentication

​
Authorization
string
required
Bearer token for authentication

​
Query Parameters

​
search
string
Search students by username, first name, last name, or email
​
page
integer
Page number for pagination (default: 1)

​
Response

​
count
integer
Total number of students in your organization
​
next
string
URL for the next page of results (null if no more pages)
​
previous
string
URL for the previous page of results (null if first page)
​
results
array
Array of student objects
curl -X GET https://api.chessplay.io/api/v1/students/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "count": 25,
  "next": "https://api.chessplay.io/api/v1/students/?page=2",
  "previous": null,
  "results": [
    {
      "id": 123,
      "username": "FastMalamute",
      "email": "john.doe@example.com",
      "phone_number": "+1234567890",
      "first_name": "John",
      "last_name": "Doe",
      "public_report_id": "abc-123-def-456",
      "created": "2024-01-15T10:30:00Z"
    },
    {
      "id": 124,
      "username": "TalentedSnail",
      "email": "jane.smith@example.com",
      "phone_number": null,
      "first_name": "Jane",
      "last_name": "Smith",
      "public_report_id": "xyz-789-uvw-012",
      "created": "2024-01-16T14:20:00Z"
    }
  ]
}

​
Search Example

Search for students by name, username, or email: 
curl -X GET "https://api.chessplay.io/api/v1/students/?search=john" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
This will return all students where “john” appears in their username, first name, last name, or email.

​
Pagination Example

Navigate through pages of results: 
# Get first page
curl -X GET "https://api.chessplay.io/api/v1/students/?page=1" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

# Get second page
curl -X GET "https://api.chessplay.io/api/v1/students/?page=2" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
The default page size is 10 students per page. All students are automatically filtered to your organization.