Reports
getActiveUsers
API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Benefits
- Reports
- GETgetBusinessUserInfo
- GETgetUserTask
- GETgetUsersByCompanyName
- GETgetCompanies
- GETgetPaidEmployeesCountBasedOnDateRange
- GETgetPayPeriodDetails
- GETgetPayPeriod
- GETgetCompanyInfo
- GETgetCompanyLocationInfo
- GETgetActiveUsers
- GETgetTerminatedUsers
- GETgetDeactivatedUsers
- GETgetPayrollHistoryBasedOnPayPeriod
- GETgetPayrollHistoryBasedOnDateRange
- GETgetPayRun
- GETgetPaySchedule
- GETgetPayStub
- GETgetTransactionBasedOnReference
- GETgetTransactions
- GETgetTransactionsBasedOnName
- GETgetBusinessUserDetails
- GETgetStateW4FormFeilds
- GETgetPayrollJournalReport
- GETgetUser
- GETgetPayBeginDates
- GETgetStateRegistration
- GETgetIndividualPayrollHistory
- GET
- Webhooks
Reports
getActiveUsers
This Report gets you all the Information regarding the Active Users
GET
/
reports#getActiveUsers
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getActiveUsers' \
--header 'Content-Type: application/json' \
--data '{
"method": "getActiveUsers",
"companyId": "3199E230-A3D8-4205-AD04-DEB7D9B7B9C2",
"workerType": "W2"
}'
{
"user": [
{
"user": "Mark anto",
"userId": "31350E00-6295-452A-9D59-0189363A869C",
"companyId": "3D1F57E5-8255-4459-A820-706529A66425",
"status": {
"userStatus": "Active"
},
"firstName": "Mark",
"lastName": "anto",
"middleName": null,
"personalEmail": null,
"phoneNumber": "7845963252",
"kycStatus": "passed",
"jobTitle": "QA",
"dateOfJoin": "2023-07-01",
"email": "leomes999@mailsac.com",
"userWages": [
{
"userWorkerType": {
"workerType": "W2"
}
}
],
"userAddress": {
"address1": "777 West Convention Way",
"address2": null,
"city": "Anaheim",
"state": "CA",
"zipcode": "92802",
"country": "US"
}
},
{
"user": "Ronald jim",
"userId": "A8F26F22-E1CA-4034-853C-4F645C667755",
"companyId": "3D1F57E5-8255-4459-A820-706529A66425",
"status": {
"userStatus": "Active"
},
"firstName": "Ronald",
"lastName": "jim",
"middleName": null,
"personalEmail": null,
"phoneNumber": "7485963202",
"kycStatus": "passed",
"jobTitle": "HR",
"dateOfJoin": "2023-07-01",
"email": "ronaldji999@mailsac.com",
"userWages": [
{
"userWorkerType": {
"workerType": "W2"
}
}
],
"userAddress": {
"address1": "777 West Convention Way",
"address2": null,
"city": "Anaheim",
"state": "CA",
"zipcode": "92802",
"country": "US"
}
}
]
}
Body
application/json
Response
200 - application/json
The response is of type object
.
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getActiveUsers' \
--header 'Content-Type: application/json' \
--data '{
"method": "getActiveUsers",
"companyId": "3199E230-A3D8-4205-AD04-DEB7D9B7B9C2",
"workerType": "W2"
}'
{
"user": [
{
"user": "Mark anto",
"userId": "31350E00-6295-452A-9D59-0189363A869C",
"companyId": "3D1F57E5-8255-4459-A820-706529A66425",
"status": {
"userStatus": "Active"
},
"firstName": "Mark",
"lastName": "anto",
"middleName": null,
"personalEmail": null,
"phoneNumber": "7845963252",
"kycStatus": "passed",
"jobTitle": "QA",
"dateOfJoin": "2023-07-01",
"email": "leomes999@mailsac.com",
"userWages": [
{
"userWorkerType": {
"workerType": "W2"
}
}
],
"userAddress": {
"address1": "777 West Convention Way",
"address2": null,
"city": "Anaheim",
"state": "CA",
"zipcode": "92802",
"country": "US"
}
},
{
"user": "Ronald jim",
"userId": "A8F26F22-E1CA-4034-853C-4F645C667755",
"companyId": "3D1F57E5-8255-4459-A820-706529A66425",
"status": {
"userStatus": "Active"
},
"firstName": "Ronald",
"lastName": "jim",
"middleName": null,
"personalEmail": null,
"phoneNumber": "7485963202",
"kycStatus": "passed",
"jobTitle": "HR",
"dateOfJoin": "2023-07-01",
"email": "ronaldji999@mailsac.com",
"userWages": [
{
"userWorkerType": {
"workerType": "W2"
}
}
],
"userAddress": {
"address1": "777 West Convention Way",
"address2": null,
"city": "Anaheim",
"state": "CA",
"zipcode": "92802",
"country": "US"
}
}
]
}