v1

latestSwagger 2.02026-07-133225142.0 KB

Employee

Get all employees

Get All Employees API will return employee data currently available in Web Pay.

get/v2/companies/{companyId}/employees/

companyIdstring required

Company Id

pagesizeinteger

Number of records per page. Default value is 25.

pagenumberinteger

Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.

includetotalcountboolean

Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.

Successfully Retrieved

employeeIdstring nullable

Employee Id.<br /> Max length: 10

statusCodestring nullable

Employee current work status. Common values are A (Active), L (Leave of Absence), T (Terminated). <br />Max length: 20

statusTypeCodestring nullable

Employee current work status type. <br />Max length: 10