Staff

This page describes all the APIs relating to staff members.

List all Staff Members

get
/api/v3/staff

Retrieve all active staff members in the school.

This endpoint returns a paginated list of staff members with their basic information including name, email, department, and contact details.

Staff members are users who have been assigned to a department and are active in the school system.

The response includes:

  • Staff member details (name, email, title, phone, etc.)

  • Department information

  • Pagination metadata

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageinteger · min: 1Optional

The page number of results to return.

Default: 1
per_pageinteger · min: 1 · max: 200Optional

Request for how many records to return.

Default: 50
countintegerOptional

Synonym for per_page

since_datestring · date_timeOptional

Return results updated since the specified date, in UTC timezone

Example: 2025-01-01T00:00:00Z
since_idintegerOptional

Return staff members with ID greater than this value

department_idintegerOptional

Filter staff members by specific department ID

department_idsstringOptional

Comma-separated list of department IDs to filter by

Responses
chevron-right
200

successful

application/json
get
/api/v3/staff

Get a Staff Member

get
/api/v3/staff/{id}

Retrieve detailed information about a specific staff member.

This endpoint returns comprehensive information about a staff member including their personal details, department assignment, and contact information.

The staff member must be active and assigned to a department to be accessible through this endpoint.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique identifier for the staff member

Responses
chevron-right
200

successful

application/json
idintegerOptional

Serial database ID that uniquely identifies the staff record

isams_idstring · nullableOptional

External iSAMS system identifier

managebac_user_idstring · nullableOptional

External ManageBac system identifier

emailstringOptional

Staff member email address

first_namestringOptional

Staff member first name

last_namestringOptional

Staff member last name

titlestring · nullableOptional

Staff member job title or position

adminbooleanOptional

Whether the staff member has admin privileges

can_admit_and_enrollbooleanOptional

Whether the staff member can admit and enroll students

can_edit_notes_and_filesbooleanOptional

Whether the staff member can edit notes and files

can_read_onlybooleanOptional

Whether the staff member has read-only access

admission_contactbooleanOptional

Whether the staff member is an admission contact

typestringOptional

Staff member type

using_ssobooleanOptional

Whether the staff member uses single sign-on

email_verifiedbooleanOptional

Whether the email address has been verified

last_sign_in_atstring · date-time · nullableOptional

Last sign-in timestamp

created_atstring · date-timeOptional

Record creation timestamp

updated_atstring · date-timeOptional

Record last update timestamp

deleted_atstring · date-time · nullableOptional

Record deletion timestamp

archived_atstring · date-time · nullableOptional

Record archival timestamp

otp_required_for_loginboolean · nullableOptional

Whether OTP is required for login

token_last_time_used_atstring · date-time · nullableOptional

Last time an API token was used

get
/api/v3/staff/{id}

Last updated

Was this helpful?