/
BO
boyahq
/
Boya Employees API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 8h ago · Updated 2w ago
Details
get
List all employees
post
Create a new employee
delete
Suspend an employee
patch
Activate an employee
post
Add money to an employee wallet
post
Deduct money from employee wallet
get
Get employee allocation/deduction transfer status
get
Get a specific employee profile and balance
get
Get All employee balances - add a specified date range
List all employees
get
/employees
Query parameters
page
integer
Page number for pagination
limit
integer
Number of items per page
Response
Successful response
Employee[]
required
id
string
name
string
phone
string
team_code
string
organization_email
string
role
string
accno
string
employee wallet accno
{"stackTrail":"components:schemas:Employee:properties:balance","oasType":"schema","type":"unknown","description":"account balance"}
status
'ACTIVE'
|
'SUSPENDED'
createdAt
string
date