Skip to navigation
API ReferenceStaff

List Inactive Staff

Returns staff who have been marked inactive (for example because they left), with their leaving date (date_of_leaving) and when their account was deactivated (deactivated_on). Includes staff deactivated by an admin and those deactivated automatically by SalaryBox, for example when the plan’s staff limit was reduced. A person made active again moves back to List Staff.

Ordered by deactivated_on, newest first; rows with no deactivated_on come last. There is no date filter: page through and stop once deactivated_on is older than the period you need.

Takes the same filters as List Staff. Returns a shorter profile than Get Staff Member (no addresses).

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

salarybox_idstringOptional
Return only the staff member with this SalaryBox ID.
employee_idstringOptional

Return only staff with exactly this company employee ID (case-sensitive).

namestringOptional

Free-text search over name, phone number and employee ID, ignoring case. For example kumar matches “Ravi Kumar”.

brancheslist of integersOptional

Repeatable. Branch ID from List Branches, for example branches=101&branches=104.

departmentslist of integersOptional

Repeatable. Department ID from List Departments, for example departments=7&departments=9.

job_titlestringOptional

Return only staff with exactly this job title (case-sensitive).

phone_numberstringOptional
Return staff whose full phone number contains these digits. Leave out the country code.
pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional
Results per page. Default 25, maximum 500.

Response

messagestring
statusboolean
datalist of objects
countinteger
Total number of matching records across all pages.
nextstring or null

URL of the next page, or null on the last page.

prevstring or null

URL of the previous page, or null on the first page.

Errors

400
Bad Request Error