List all employees

Changed on Aug 14, 2026

get/employees

Request

Base URL
https://api.boyahq.com/v1
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/boyahq/apis/boya-employees-api/docs/employees/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger

Page number (1-based).

limitinteger

Number of items per page.

Response

Successful response

idstring

namestring

phonestring

team_codestring

organization_emailstring

rolestring

accnostring

employee wallet accno

balancenumber double

account balance

status'ACTIVE' | 'SUSPENDED'

createdAtstring date

Changes

Aug 14, 2026190d4c90e3ab Revision changes
- breaking
  the / response's property type changed from double to number, and format from no format to double for status
- warning
  for the query request parameter limit, the min was set to 1.00
- warning
  for the query request parameter page, the min was set to 1.00
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history