Staff

Gets a paginated list of staff members

get

/api/v1/Staff

Authorizations

AuthorizationstringRequired

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

Query parameters

IncludeArchivedbooleanOptional

Searchstring · max: 200Optional

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/Staff

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

{
  "isSuccess": true,
  "errors": [
    "text"
  ],
  "messageTranslationParameters": null,
  "data": [
    {
      "id": 1,
      "organisationId": 1,
      "staffId": "text",
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "role": "Staff",
      "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 staff member

post

/api/v1/Staff

Authorizations

AuthorizationstringRequired

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

Query parameters

organisationIdinteger · int32Optional

Body

staffIdstring · max: 50 · nullableOptional

titlestring · max: 10 · nullableOptional

lastNamestring · max: 50 · nullableOptional

firstNamestring · max: 50 · nullableOptional

emailstring · max: 250 · nullableOptional

onlineMeetingIdstring · max: 250 · nullableOptional

isArchivedboolean · max: 1Optional

mobilePhonestring · max: 250 · nullableOptional

phoneNumberstring · max: 250 · nullableOptional

updateablebooleanOptional

rolestring · enumOptionalPossible values:

Responses

201

Created

application/json

idinteger · int32 · nullableOptional

organisationIdinteger · int32 · nullableOptional

staffIdstring · nullableOptional

titlestring · nullableOptional

lastNamestring · nullableOptional

firstNamestring · nullableOptional

emailstring · nullableOptional

rolestring · enumOptionalPossible values:

onlineMeetingIdstring · nullableOptional

isArchivedbooleanOptional

mobilePhonestring · nullableOptional

phoneNumberstring · nullableOptional

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/Staff

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

{
  "staffId": "text",
  "title": "text",
  "lastName": "text",
  "firstName": "text",
  "email": "text",
  "onlineMeetingId": "text",
  "isArchived": true,
  "mobilePhone": "text",
  "phoneNumber": "text",
  "updateable": true,
  "role": "Staff"
}

{
  "id": 1,
  "organisationId": 1,
  "staffId": "text",
  "title": "text",
  "lastName": "text",
  "firstName": "text",
  "email": "text",
  "role": "Staff",
  "onlineMeetingId": "text",
  "isArchived": true,
  "mobilePhone": "text",
  "phoneNumber": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "updatable": true
}

Get staff by Id (full details).

get

/api/v1/Staff/{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

organisationIdinteger · int32 · nullableOptional

staffIdstring · nullableOptional

titlestring · nullableOptional

lastNamestring · nullableOptional

firstNamestring · nullableOptional

emailstring · nullableOptional

rolestring · enumOptionalPossible values:

onlineMeetingIdstring · nullableOptional

isArchivedbooleanOptional

mobilePhonestring · nullableOptional

phoneNumberstring · nullableOptional

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/Staff/{id}

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

{
  "id": 1,
  "organisationId": 1,
  "staffId": "text",
  "title": "text",
  "lastName": "text",
  "firstName": "text",
  "email": "text",
  "role": "Staff",
  "onlineMeetingId": "text",
  "isArchived": true,
  "mobilePhone": "text",
  "phoneNumber": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "updatable": true
}

Update an existing staff.

put

/api/v1/Staff/{id}

Authorizations

AuthorizationstringRequired

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

Path parameters

idinteger · int32Required

Query parameters

organisationIdinteger · int32Optional

Body

staffIdstring · max: 50 · nullableOptional

titlestring · max: 10 · nullableOptional

lastNamestring · max: 50 · nullableOptional

firstNamestring · max: 50 · nullableOptional

emailstring · max: 250 · nullableOptional

onlineMeetingIdstring · max: 250 · nullableOptional

isArchivedboolean · max: 1Optional

mobilePhonestring · max: 250 · nullableOptional

phoneNumberstring · max: 250 · nullableOptional

Responses

200

OK

application/json

idinteger · int32 · nullableOptional

organisationIdinteger · int32 · nullableOptional

staffIdstring · nullableOptional

titlestring · nullableOptional

lastNamestring · nullableOptional

firstNamestring · nullableOptional

emailstring · nullableOptional

rolestring · enumOptionalPossible values:

onlineMeetingIdstring · nullableOptional

isArchivedbooleanOptional

mobilePhonestring · nullableOptional

phoneNumberstring · nullableOptional

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

put/api/v1/Staff/{id}

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

{
  "staffId": "text",
  "title": "text",
  "lastName": "text",
  "firstName": "text",
  "email": "text",
  "onlineMeetingId": "text",
  "isArchived": true,
  "mobilePhone": "text",
  "phoneNumber": "text"
}

{
  "id": 1,
  "organisationId": 1,
  "staffId": "text",
  "title": "text",
  "lastName": "text",
  "firstName": "text",
  "email": "text",
  "role": "Staff",
  "onlineMeetingId": "text",
  "isArchived": true,
  "mobilePhone": "text",
  "phoneNumber": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "updatable": true
}

Bulk update OnlineMeetingId for staff members.

patch

/api/v1/Staff/BulkUpdateOnlineMeetingId

Authorizations

AuthorizationstringRequired

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

Query parameters

organisationIdinteger · int32Optional

Optional organisation ID

Bodyobject · StaffOnlineMeetingIdItemDto[]

idinteger · int32Required

onlineMeetingIdstring · min: 1 · max: 250Required

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch/api/v1/Staff/BulkUpdateOnlineMeetingId

PATCH /api/v1/Staff/BulkUpdateOnlineMeetingId HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

[
  {
    "id": 1,
    "onlineMeetingId": "text"
  }
]

No content

Bulk archive or unarchive staff.

post

/api/v1/Staff/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/Staff/BulkArchive

POST /api/v1/Staff/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