Staff

This page describes all the APIs relating to staff members.

List all Staff Members

get

https://api.openapply.comhttps://api.openapply.cn

/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

bearerAuth

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

200

successful

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/api/v3/staff

HTTPcURLJavaScriptPython

GET /api/v3/staff HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "staff": [
    {
      "id": 1,
      "isams_id": "text",
      "managebac_user_id": "text",
      "email": "text",
      "first_name": "text",
      "last_name": "text",
      "title": "text",
      "properties": {
        "phone": "text"
      },
      "admin": true,
      "can_admit_and_enroll": true,
      "can_edit_notes_and_files": true,
      "can_read_only": true,
      "admission_contact": true,
      "type": "text",
      "department": {
        "id": 1,
        "name": "text"
      },
      "using_sso": true,
      "email_verified": true,
      "last_sign_in_at": "2026-03-05T17:27:06.521Z",
      "created_at": "2026-03-05T17:27:06.521Z",
      "updated_at": "2026-03-05T17:27:06.521Z",
      "deleted_at": "2026-03-05T17:27:06.521Z",
      "archived_at": "2026-03-05T17:27:06.521Z",
      "otp_required_for_login": true,
      "token_last_time_used_at": "2026-03-05T17:27:06.521Z"
    }
  ],
  "meta": {
    "pages": 1,
    "per_page": 1,
    "count": 1
  }
}

Get a Staff Member

get

https://api.openapply.comhttps://api.openapply.cn

/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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Unique identifier for the staff member

Responses

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

401

Unauthorized

application/json

404

Staff member not found

application/json

get

/api/v3/staff/{id}

HTTPcURLJavaScriptPython

GET /api/v3/staff/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "staff": {
    "id": 123,
    "first_name": "John",
    "last_name": "Smith",
    "email": "[email protected]",
    "title": "Mathematics Teacher",
    "phone": "[phone]",
    "department_id": 456,
    "position": "Teacher",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}