Students

Gets a paginated list of students

get

/api/v1/Students

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Query parameters

IncludeArchivedbooleanOptional

Searchstring · max: 200Optional

Gradestring · max: 100Optional

HomeroomClassstring · max: 100Optional

Housestring · max: 100Optional

HomeroomAdvisorIdstringOptional

SCStudentIdsinteger · int32[]Optional

StudentIdsstring[]Optional

PageNumberinteger · int32 · min: 1 · max: 2147483647Optional

PageSizeinteger · int32 · min: 1 · max: 2000Optional

OrganisationIdsinteger · int32[]Optional

Responses

200

OK

application/json

isSuccessbooleanOptional

errorsstring[] · nullableOptional

messageTranslationParametersany · nullableOptional

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

firstPagestring · uri · nullableOptional

lastPagestring · uri · nullableOptional

totalPagesinteger · int32Optional

totalRecordsinteger · int32Optional

nextPagestring · uri · nullableOptional

previousPagestring · uri · nullableOptional

baseUristring · uri · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/api/v1/Students

GET /api/v1/Students HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "errors": [
    "text"
  ],
  "messageTranslationParameters": null,
  "data": [
    {
      "id": 1,
      "organisationId": 1,
      "studentId": "text",
      "studentDisplayId": "text",
      "lastName": "text",
      "firstName": "text",
      "middleName": "text",
      "otherName": "text",
      "dateOfBirth": "2026-01-01",
      "email": "text",
      "gender": "text",
      "house": "text",
      "grade": "text",
      "homeroomClass": "text",
      "homeroomAdvisorId": 1,
      "homeroomAdvisor": "text",
      "relatedPeople": [
        1
      ],
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "isArchived": true,
      "updatable": true
    }
  ],
  "pageNumber": 1,
  "pageSize": 1,
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "totalPages": 1,
  "totalRecords": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "baseUri": "https://example.com",
  "searchParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Create a new student.

post

/api/v1/Students

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Query parameters

organisationIdinteger · int32Optional

Body

studentIdstring · max: 50 · nullableOptional

studentDisplayIdstring · max: 200 · nullableOptional

qrCodestring · max: 50 · nullableOptional

lastNamestring · min: 1 · max: 50Required

firstNamestring · min: 1 · max: 50Required

middleNamestring · max: 100 · nullableOptional

genderstring · enumRequiredPossible values:

otherNamestring · max: 100 · nullableOptional

emailstring · email · max: 256 · nullableOptional

dateOfBirthstring · date · nullableOptional

housestring · max: 100 · nullableOptional

gradestring · min: 1 · max: 100Required

homeroomClassstring · max: 100 · nullableOptional

senboolean · nullableOptional

Responses

201

Created

application/json

idinteger · int32 · nullableOptional

studentIdstring · nullableOptional

studentDisplayIdstring · nullableOptional

qrCodestring · nullableOptional

lastNamestring · nullableOptional

firstNamestring · nullableOptional

middleNamestring · nullableOptional

otherNamestring · nullableOptional

genderstring · nullableOptional

emailstring · nullableOptional

dateOfBirthstring · date · nullableOptional

housestring · nullableOptional

gradestring · nullableOptional

homeroomClassstring · nullableOptional

homeroomAdvisorIdinteger · int32 · nullableOptional

homeroomAdvisorstring · nullableOptional

senboolean · nullableOptional

relatedPeopleinteger · int32[] · nullableOptional

isArchivedbooleanOptional

createdAtstring · date-time · nullableOptional

updatedAtstring · date-time · nullableOptional

updatablebooleanOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v1/Students

POST /api/v1/Students HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "studentId": "text",
  "studentDisplayId": "text",
  "qrCode": "text",
  "lastName": "text",
  "firstName": "text",
  "middleName": "text",
  "gender": "Female",
  "otherName": "text",
  "email": "[e-mail]",
  "dateOfBirth": "2026-01-01",
  "house": "text",
  "grade": "text",
  "homeroomClass": "text",
  "sen": true
}

{
  "id": 1,
  "studentId": "text",
  "studentDisplayId": "text",
  "qrCode": "text",
  "lastName": "text",
  "firstName": "text",
  "middleName": "text",
  "otherName": "text",
  "gender": "text",
  "email": "text",
  "dateOfBirth": "2026-01-01",
  "house": "text",
  "grade": "text",
  "homeroomClass": "text",
  "homeroomAdvisorId": 1,
  "homeroomAdvisor": "text",
  "sen": true,
  "relatedPeople": [
    1
  ],
  "isArchived": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "updatable": true
}

Get student by Id (full details).

get

/api/v1/Students/{id}

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters

idinteger · int32Required

Query parameters

organisationIdinteger · int32Optional

Responses

200

OK

application/json

idinteger · int32 · nullableOptional

studentIdstring · nullableOptional

studentDisplayIdstring · nullableOptional

qrCodestring · nullableOptional

lastNamestring · nullableOptional

firstNamestring · nullableOptional

middleNamestring · nullableOptional

otherNamestring · nullableOptional

genderstring · nullableOptional

emailstring · nullableOptional

dateOfBirthstring · date · nullableOptional

housestring · nullableOptional

gradestring · nullableOptional

homeroomClassstring · nullableOptional

homeroomAdvisorIdinteger · int32 · nullableOptional

homeroomAdvisorstring · nullableOptional

senboolean · nullableOptional

relatedPeopleinteger · int32[] · nullableOptional

isArchivedbooleanOptional

createdAtstring · date-time · nullableOptional

updatedAtstring · date-time · nullableOptional

updatablebooleanOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/api/v1/Students/{id}

GET /api/v1/Students/{id} HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "studentId": "text",
  "studentDisplayId": "text",
  "qrCode": "text",
  "lastName": "text",
  "firstName": "text",
  "middleName": "text",
  "otherName": "text",
  "gender": "text",
  "email": "text",
  "dateOfBirth": "2026-01-01",
  "house": "text",
  "grade": "text",
  "homeroomClass": "text",
  "homeroomAdvisorId": 1,
  "homeroomAdvisor": "text",
  "sen": true,
  "relatedPeople": [
    1
  ],
  "isArchived": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "updatable": true
}

Update an existing student.

put

/api/v1/Students/{id}

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters

idinteger · int32Required

Query parameters

organisationIdinteger · int32Optional

Body

studentIdstring · max: 50 · nullableOptional

studentDisplayIdstring · max: 200 · nullableOptional

qrCodestring · max: 50 · nullableOptional

lastNamestring · min: 1 · max: 50Required

firstNamestring · min: 1 · max: 50Required

middleNamestring · max: 100 · nullableOptional

genderstring · enumRequiredPossible values:

otherNamestring · max: 100 · nullableOptional

emailstring · email · max: 256 · nullableOptional

dateOfBirthstring · date · nullableOptional

housestring · max: 100 · nullableOptional

gradestring · min: 1 · max: 100Required

homeroomClassstring · max: 100 · nullableOptional

senboolean · nullableOptional

isArchivedbooleanOptional

Responses

200

OK

application/json

idinteger · int32 · nullableOptional

studentIdstring · nullableOptional

studentDisplayIdstring · nullableOptional

qrCodestring · nullableOptional

lastNamestring · nullableOptional

firstNamestring · nullableOptional

middleNamestring · nullableOptional

otherNamestring · nullableOptional

genderstring · nullableOptional

emailstring · nullableOptional

dateOfBirthstring · date · nullableOptional

housestring · nullableOptional

gradestring · nullableOptional

homeroomClassstring · nullableOptional

homeroomAdvisorIdinteger · int32 · nullableOptional

homeroomAdvisorstring · nullableOptional

senboolean · nullableOptional

relatedPeopleinteger · int32[] · nullableOptional

isArchivedbooleanOptional

createdAtstring · date-time · nullableOptional

updatedAtstring · date-time · nullableOptional

updatablebooleanOptional

400

Bad Request

application/json

404

Not Found

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

put/api/v1/Students/{id}

PUT /api/v1/Students/{id} HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "studentId": "text",
  "studentDisplayId": "text",
  "qrCode": "text",
  "lastName": "text",
  "firstName": "text",
  "middleName": "text",
  "gender": "Female",
  "otherName": "text",
  "email": "[e-mail]",
  "dateOfBirth": "2026-01-01",
  "house": "text",
  "grade": "text",
  "homeroomClass": "text",
  "sen": true,
  "isArchived": true
}

{
  "id": 1,
  "studentId": "text",
  "studentDisplayId": "text",
  "qrCode": "text",
  "lastName": "text",
  "firstName": "text",
  "middleName": "text",
  "otherName": "text",
  "gender": "text",
  "email": "text",
  "dateOfBirth": "2026-01-01",
  "house": "text",
  "grade": "text",
  "homeroomClass": "text",
  "homeroomAdvisorId": 1,
  "homeroomAdvisor": "text",
  "sen": true,
  "relatedPeople": [
    1
  ],
  "isArchived": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "updatable": true
}

Bulk archive or unarchive students.

post

/api/v1/Students/BulkArchive

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Query parameters

organisationIdinteger · int32Optional

Body

archivebooleanOptional

idsinteger · int32[] · min: 1Required

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v1/Students/BulkArchive

POST /api/v1/Students/BulkArchive HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "archive": true,
  "ids": [
    1
  ]
}

No content

Gets student health information by student identifier

get

/api/v1/Students/{id}/health

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters

idinteger · int32Required

The student identifier

Query parameters

organisationIdinteger · int32Optional

Responses

200

OK

application/json

idinteger · int32Optional

descriptionstring · nullableOptional

notesstring · nullableOptional

updatedAtstring · date-time · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/api/v1/Students/{id}/health

GET /api/v1/Students/{id}/health HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "description": "text",
    "notes": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
]

Updates student health information

patch

/api/v1/Students/{id}/health

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters

idinteger · int32Required

The person identifier

Query parameters

organisationIdinteger · int32Optional

Bodyobject · StudentHealthUpdateRequestDto[]

idinteger · int32Optional

descriptionstring · nullableOptional

notesstring · nullableOptional

Responses

200

OK

application/json

idinteger · int32Optional

descriptionstring · nullableOptional

notesstring · nullableOptional

updatedAtstring · date-time · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch/api/v1/Students/{id}/health

PATCH /api/v1/Students/{id}/health HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 46

[
  {
    "id": 1,
    "description": "text",
    "notes": "text"
  }
]

[
  {
    "id": 1,
    "description": "text",
    "notes": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
]

Add contacts to a student.

post

/api/v1/Students/{id}/contacts

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters

idinteger · int32Required

Student ID

Query parameters

organisationIdinteger · int32Optional

Organisation Id (optional query parameter)

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

idinteger · int32 · nullableOptional

studentIdstring · nullableOptional

studentDisplayIdstring · nullableOptional

qrCodestring · nullableOptional

lastNamestring · nullableOptional

firstNamestring · nullableOptional

middleNamestring · nullableOptional

otherNamestring · nullableOptional

genderstring · nullableOptional

emailstring · nullableOptional

dateOfBirthstring · date · nullableOptional

housestring · nullableOptional

gradestring · nullableOptional

homeroomClassstring · nullableOptional

homeroomAdvisorIdinteger · int32 · nullableOptional

homeroomAdvisorstring · nullableOptional

senboolean · nullableOptional

relatedPeopleinteger · int32[] · nullableOptional

isArchivedbooleanOptional

createdAtstring · date-time · nullableOptional

updatedAtstring · date-time · nullableOptional

updatablebooleanOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v1/Students/{id}/contacts

POST /api/v1/Students/{id}/contacts HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

{
  "id": 1,
  "studentId": "text",
  "studentDisplayId": "text",
  "qrCode": "text",
  "lastName": "text",
  "firstName": "text",
  "middleName": "text",
  "otherName": "text",
  "gender": "text",
  "email": "text",
  "dateOfBirth": "2026-01-01",
  "house": "text",
  "grade": "text",
  "homeroomClass": "text",
  "homeroomAdvisorId": 1,
  "homeroomAdvisor": "text",
  "sen": true,
  "relatedPeople": [
    1
  ],
  "isArchived": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "updatable": true
}

Remove contacts from a student.

delete

/api/v1/Students/{id}/contacts

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters

idinteger · int32Required

Student ID

Query parameters

organisationIdinteger · int32Optional

Organisation Id (optional query parameter)

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

idinteger · int32 · nullableOptional

studentIdstring · nullableOptional

studentDisplayIdstring · nullableOptional

qrCodestring · nullableOptional

lastNamestring · nullableOptional

firstNamestring · nullableOptional

middleNamestring · nullableOptional

otherNamestring · nullableOptional

genderstring · nullableOptional

emailstring · nullableOptional

dateOfBirthstring · date · nullableOptional

housestring · nullableOptional

gradestring · nullableOptional

homeroomClassstring · nullableOptional

homeroomAdvisorIdinteger · int32 · nullableOptional

homeroomAdvisorstring · nullableOptional

senboolean · nullableOptional

relatedPeopleinteger · int32[] · nullableOptional

isArchivedbooleanOptional

createdAtstring · date-time · nullableOptional

updatedAtstring · date-time · nullableOptional

updatablebooleanOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete/api/v1/Students/{id}/contacts

DELETE /api/v1/Students/{id}/contacts HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

{
  "id": 1,
  "studentId": "text",
  "studentDisplayId": "text",
  "qrCode": "text",
  "lastName": "text",
  "firstName": "text",
  "middleName": "text",
  "otherName": "text",
  "gender": "text",
  "email": "text",
  "dateOfBirth": "2026-01-01",
  "house": "text",
  "grade": "text",
  "homeroomClass": "text",
  "homeroomAdvisorId": 1,
  "homeroomAdvisor": "text",
  "sen": true,
  "relatedPeople": [
    1
  ],
  "isArchived": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "updatable": true
}