> For the complete documentation index, see [llms.txt](https://guide.fariaedu.com/integrations-portal/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.fariaedu.com/integrations-portal/openapply/public-rest-apis/v3/staff.md).

# Staff

This page describes all the APIs relating to staff members.

## List all Staff Members

> 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<br>

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Staff","description":"This page describes all the APIs relating to staff members."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Staff":{"type":"object","properties":{"id":{"type":"integer","description":"Serial database ID that uniquely identifies the staff record"},"isams_id":{"type":"string","nullable":true,"description":"External iSAMS system identifier"},"managebac_user_id":{"type":"string","nullable":true,"description":"External ManageBac system identifier"},"email":{"type":"string","description":"Staff member email address"},"first_name":{"type":"string","description":"Staff member first name"},"last_name":{"type":"string","description":"Staff member last name"},"title":{"type":"string","nullable":true,"description":"Staff member job title or position"},"properties":{"type":"object","nullable":true,"description":"Additional staff properties","properties":{"phone":{"type":"string","nullable":true,"description":"Staff member phone number"}}},"admin":{"type":"boolean","description":"Whether the staff member has admin privileges"},"can_admit_and_enroll":{"type":"boolean","description":"Whether the staff member can admit and enroll students"},"can_edit_notes_and_files":{"type":"boolean","description":"Whether the staff member can edit notes and files"},"can_read_only":{"type":"boolean","description":"Whether the staff member has read-only access"},"admission_contact":{"type":"boolean","description":"Whether the staff member is an admission contact"},"type":{"type":"string","description":"Staff member type"},"department":{"type":"object","nullable":true,"description":"Department information","properties":{"id":{"type":"integer","description":"Department ID"},"name":{"type":"string","description":"Department name"}}},"using_sso":{"type":"boolean","description":"Whether the staff member uses single sign-on"},"email_verified":{"type":"boolean","description":"Whether the email address has been verified"},"last_sign_in_at":{"type":"string","format":"date-time","nullable":true,"description":"Last sign-in timestamp"},"created_at":{"type":"string","format":"date-time","description":"Record creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Record last update timestamp"},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"Record deletion timestamp"},"archived_at":{"type":"string","format":"date-time","nullable":true,"description":"Record archival timestamp"},"otp_required_for_login":{"type":"boolean","nullable":true,"description":"Whether OTP is required for login"},"token_last_time_used_at":{"type":"string","format":"date-time","nullable":true,"description":"Last time an API token was used"}}}}},"paths":{"/api/v3/staff":{"get":{"summary":"List all Staff Members","tags":["Staff"],"operationId":"ListStaff","description":"Retrieve all active staff members in the school.\n\nThis endpoint returns a paginated list of staff members with their basic information\nincluding name, email, department, and contact details.\n\nStaff members are users who have been assigned to a department and are active\nin the school system.\n\nThe response includes:\n- Staff member details (name, email, title, phone, etc.)\n- Department information\n- Pagination metadata\n","parameters":[{"name":"page","in":"query","required":false,"description":"The page number of results to return.","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"description":"Request for how many records to return.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"count","in":"query","required":false,"description":"Synonym for per_page","schema":{"type":"integer"}},{"name":"since_date","in":"query","required":false,"description":"Return results updated since the specified date, in UTC timezone","schema":{"type":"string","format":"date_time"}},{"name":"since_id","in":"query","required":false,"description":"Return staff members with ID greater than this value","schema":{"type":"integer"}},{"name":"department_id","in":"query","required":false,"description":"Filter staff members by specific department ID","schema":{"type":"integer"}},{"name":"department_ids","in":"query","required":false,"description":"Comma-separated list of department IDs to filter by","schema":{"type":"string"}}],"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","properties":{"staff":{"type":"array","items":{"$ref":"#/components/schemas/Staff"}},"meta":{"type":"object","properties":{"pages":{"type":"integer"},"per_page":{"type":"integer"},"count":{"type":"integer"}}}},"required":["staff","meta"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}}}}
```

## Get a Staff Member

> 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.<br>

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Staff","description":"This page describes all the APIs relating to staff members."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Staff":{"type":"object","properties":{"id":{"type":"integer","description":"Serial database ID that uniquely identifies the staff record"},"isams_id":{"type":"string","nullable":true,"description":"External iSAMS system identifier"},"managebac_user_id":{"type":"string","nullable":true,"description":"External ManageBac system identifier"},"email":{"type":"string","description":"Staff member email address"},"first_name":{"type":"string","description":"Staff member first name"},"last_name":{"type":"string","description":"Staff member last name"},"title":{"type":"string","nullable":true,"description":"Staff member job title or position"},"properties":{"type":"object","nullable":true,"description":"Additional staff properties","properties":{"phone":{"type":"string","nullable":true,"description":"Staff member phone number"}}},"admin":{"type":"boolean","description":"Whether the staff member has admin privileges"},"can_admit_and_enroll":{"type":"boolean","description":"Whether the staff member can admit and enroll students"},"can_edit_notes_and_files":{"type":"boolean","description":"Whether the staff member can edit notes and files"},"can_read_only":{"type":"boolean","description":"Whether the staff member has read-only access"},"admission_contact":{"type":"boolean","description":"Whether the staff member is an admission contact"},"type":{"type":"string","description":"Staff member type"},"department":{"type":"object","nullable":true,"description":"Department information","properties":{"id":{"type":"integer","description":"Department ID"},"name":{"type":"string","description":"Department name"}}},"using_sso":{"type":"boolean","description":"Whether the staff member uses single sign-on"},"email_verified":{"type":"boolean","description":"Whether the email address has been verified"},"last_sign_in_at":{"type":"string","format":"date-time","nullable":true,"description":"Last sign-in timestamp"},"created_at":{"type":"string","format":"date-time","description":"Record creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Record last update timestamp"},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"Record deletion timestamp"},"archived_at":{"type":"string","format":"date-time","nullable":true,"description":"Record archival timestamp"},"otp_required_for_login":{"type":"boolean","nullable":true,"description":"Whether OTP is required for login"},"token_last_time_used_at":{"type":"string","format":"date-time","nullable":true,"description":"Last time an API token was used"}}}}},"paths":{"/api/v3/staff/{id}":{"get":{"summary":"Get a Staff Member","tags":["Staff"],"operationId":"getOneStaff","description":"Retrieve detailed information about a specific staff member.\n\nThis endpoint returns comprehensive information about a staff member\nincluding their personal details, department assignment, and contact information.\n\nThe staff member must be active and assigned to a department to be accessible\nthrough this endpoint.\n","parameters":[{"name":"id","in":"path","required":true,"description":"Unique identifier for the staff member","schema":{"type":"integer"}}],"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Staff"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"404":{"description":"Staff member not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}}}}
```