Reports
getActiveUsers
- Documentation
- API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Reports
- GETgetBusinessUserInfo
- GETgetUserTask
- GETgetPaidEmployeesCountBasedOnDateRange
- GETgetPayPeriodDetails
- GETgetPayPeriod
- GETgetCompanyInfo
- GETgetCompanyLocationInfo
- GETgetActiveUsers
- GETgetTerminatedUsers
- GETgetDeactivatedUsers
- GETgetPayrollHistoryBasedOnPayPeriod
- GETgetPayrollHistoryBasedOnDateRange
- GETgetPayRun
- GETgetPaySchedule
- GETgetPayStub
- GETgetTransactionBasedOnReference
- GETgetTransactions
- GETgetTransactionsBasedOnName
- GETgetBusinessUserDetails
- GETgetIndividualPayrollHistory
- GET
API Reference
Reports
getActiveUsers
This Report gets you all the Information regarding the Active Users
GET
/
reports#getActiveUsers
Authorization
object
*
Authorization
Required
object
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
username
string
username
string
password
string
password
string
object
method
getActiveUsers · string
*
method
Required
string
Add Example Value
companyId
string
*
companyId
Required
string
Body
application/json
method
string
default: getActiveUsersrequiredcompanyId
string
requiredResponse
200 - application/json
user
object[]
requireduser.user
string
requireduser.userId
string
requireduser.companyId
string
requireduser.status
object
requireduser.status.userStatus
string
requireduser.firstName
string
requireduser.lastName
string
requireduser.middleName
string
requireduser.personalEmail
string
requireduser.phoneNumber
string
requireduser.kycStatus
string
requireduser.jobTitle
string
requireduser.dateOfJoin
string
requireduser.email
string
requireduser.userWages
object[]
requireduser.userWages.userWorkerType
object
requireduser.userWages.userWorkerType.workerType
string
requireduser.userAddress
object
requireduser.userAddress.address1
string
requireduser.userAddress.address2
string
requireduser.userAddress.city
string
requireduser.userAddress.state
string
requireduser.userAddress.zipcode
string
requireduser.userAddress.country
string
required