Skip to content

List all employees

Request

Security
ApiKeyAuth
Query
pageinteger, >= 1

Page number (1-based).

Default:1
limitinteger, >= 1

Number of items per page.

Default:50
curl -i -X GET \
  'https://developer.boyahq.com/_mock/employee/employees?page=1&limit=50' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
Array [
idstring
namestring
phonestring
team_codestring
organization_emailstring
rolestring
accnostring

employee wallet accno

balancenumber, (double)

account balance

statusstring
Enum:"ACTIVE""SUSPENDED"
createdAtstring, (date)
]
Response
[
  {
    "id": "string",
    "name": "string",
    "phone": "string",
    "team_code": "string",
    "organization_email": "string",
    "role": "string",
    "accno": "string",
    "balance": 0.1,
    "status": "ACTIVE",
    "createdAt": "2019-08-24"
  }
]