API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Benefits
- Reports
- GETgetBusinessUserInfo
- GETgetUserTask
- GETgetUsersByCompanyName
- GETgetCompanies
- GETgetPaidEmployeesCountBasedOnDateRange
- GETgetPayPeriodDetails
- GETgetPayPeriod
- GETgetOverTimeTypes
- GETgetDeductionDescription
- GETgetAdditionalCompensationDescription
- GETgetUsers
- GETgetCompanyInfo
- GETgetCompanyLocationInfo
- GETgetActiveUsers
- GETgetTerminatedUsers
- GETgetDeactivatedUsers
- GETgetPayrollHistoryBasedOnPayPeriod
- GETgetPayrollHistoryBasedOnDateRange
- GETgetPayRun
- GETgetPaySchedule
- GETgetPayStub
- GETgetTransactionBasedOnReference
- GETgetTransactions
- GETgetTransactionsBasedOnName
- GETgetBusinessUserDetails
- GETgetStateW4FormFeilds
- GETgetPayrollJournalReport
- GETgetUser
- GETgetPayBeginDates
- GETgetStateRegistration
- GETgetIndividualPayrollHistory
- GET
- Webhooks
Reports
getUsers
GET
/
reports#getUsers
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getUsers' \
--header 'Content-Type: application/json' \
--data '{
"method": "getUsers",
"companyId": "CFC4D743-4869-4799-B1AF-B615D6CF21E5"
}'
{
"users": [
{
"user": "Kehlani Foley",
"userId": "377213DD-AF45-4FB1-ABEE-5F11BDE2C437",
"companyId": "582C407F-4398-4F0A-AF67-4363D7CD7795",
"status": {
"userStatus": "Active"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Kehlani",
"lastName": "Foley",
"middleName": "",
"phoneNumber": "2631213690",
"kycStatus": "passed",
"jobTitle": "Manager",
"dateOfJoin": "2023-01-01",
"email": "foley1803@mailsac.com",
"userWages": [
{
"WageRate": 3560,
"WageBasis": {
"WageBasis": "Per Week"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
}
}
],
"userAddress": {
"address1": "102 Fallsgrove Blvd",
"address2": "",
"city": "Rockville",
"state": "MD",
"zipcode": "20850",
"country": "US"
}
},
{
"user": "Stormi Douglas",
"userId": "7CB45BFC-D5C1-4B24-9F53-8666690D13D4",
"companyId": "582C407F-4398-4F0A-AF67-4363D7CD7795",
"status": {
"userStatus": "Active"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Stormi",
"lastName": "Douglas",
"middleName": "",
"phoneNumber": "2631213690",
"kycStatus": "passed",
"jobTitle": "Manager",
"dateOfJoin": "2023-01-01",
"email": "stormi1803@mailsac.com",
"userWages": [
{
"WageRate": 0,
"WageBasis": {
"WageBasis": "Per Hour"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
}
}
],
"userAddress": {
"address1": "102 Fallsgrove Blvd",
"address2": "",
"city": "Rockville",
"state": "MD",
"zipcode": "20850",
"country": "US"
}
},
{
"user": "Sydney Pham",
"userId": "5C5F7A54-39DF-402D-A727-E2E0D52A2A82",
"companyId": "582C407F-4398-4F0A-AF67-4363D7CD7795",
"status": {
"userStatus": "Invite Sent"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Sydney",
"lastName": "Pham",
"middleName": "",
"phoneNumber": "2631213690",
"kycStatus": "passed",
"jobTitle": "Manager",
"dateOfJoin": "2023-01-01",
"email": "pham803@mailsac.com",
"userWages": [
{
"WageRate": 3560,
"WageBasis": {
"WageBasis": "Per Week"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
}
}
],
"userAddress": {
"address1": "102 Fallsgrove Blvd",
"address2": "",
"city": "Rockville",
"state": "MD",
"zipcode": "20850",
"country": "US"
}
},
{
"user": "Kehlani Foley",
"userId": "B9E7417A-00AA-4BC5-8DA4-E589CC04E1BF",
"companyId": "582C407F-4398-4F0A-AF67-4363D7CD7795",
"status": {
"userStatus": "Add Wage"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Kehlani",
"lastName": "Foley",
"middleName": "",
"phoneNumber": "2631213690",
"kycStatus": "new",
"jobTitle": "Manager",
"dateOfJoin": "2023-01-01",
"email": "foley1803hhhggffyffyufyugfugugiuhugygyftydrdtrdesessehssss@mailsac.com",
"userWages": [],
"userAddress": null
}
]
}
Body
application/json
Response
200
application/json
The response is of type object
.
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getUsers' \
--header 'Content-Type: application/json' \
--data '{
"method": "getUsers",
"companyId": "CFC4D743-4869-4799-B1AF-B615D6CF21E5"
}'
{
"users": [
{
"user": "Kehlani Foley",
"userId": "377213DD-AF45-4FB1-ABEE-5F11BDE2C437",
"companyId": "582C407F-4398-4F0A-AF67-4363D7CD7795",
"status": {
"userStatus": "Active"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Kehlani",
"lastName": "Foley",
"middleName": "",
"phoneNumber": "2631213690",
"kycStatus": "passed",
"jobTitle": "Manager",
"dateOfJoin": "2023-01-01",
"email": "foley1803@mailsac.com",
"userWages": [
{
"WageRate": 3560,
"WageBasis": {
"WageBasis": "Per Week"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
}
}
],
"userAddress": {
"address1": "102 Fallsgrove Blvd",
"address2": "",
"city": "Rockville",
"state": "MD",
"zipcode": "20850",
"country": "US"
}
},
{
"user": "Stormi Douglas",
"userId": "7CB45BFC-D5C1-4B24-9F53-8666690D13D4",
"companyId": "582C407F-4398-4F0A-AF67-4363D7CD7795",
"status": {
"userStatus": "Active"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Stormi",
"lastName": "Douglas",
"middleName": "",
"phoneNumber": "2631213690",
"kycStatus": "passed",
"jobTitle": "Manager",
"dateOfJoin": "2023-01-01",
"email": "stormi1803@mailsac.com",
"userWages": [
{
"WageRate": 0,
"WageBasis": {
"WageBasis": "Per Hour"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
}
}
],
"userAddress": {
"address1": "102 Fallsgrove Blvd",
"address2": "",
"city": "Rockville",
"state": "MD",
"zipcode": "20850",
"country": "US"
}
},
{
"user": "Sydney Pham",
"userId": "5C5F7A54-39DF-402D-A727-E2E0D52A2A82",
"companyId": "582C407F-4398-4F0A-AF67-4363D7CD7795",
"status": {
"userStatus": "Invite Sent"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Sydney",
"lastName": "Pham",
"middleName": "",
"phoneNumber": "2631213690",
"kycStatus": "passed",
"jobTitle": "Manager",
"dateOfJoin": "2023-01-01",
"email": "pham803@mailsac.com",
"userWages": [
{
"WageRate": 3560,
"WageBasis": {
"WageBasis": "Per Week"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
}
}
],
"userAddress": {
"address1": "102 Fallsgrove Blvd",
"address2": "",
"city": "Rockville",
"state": "MD",
"zipcode": "20850",
"country": "US"
}
},
{
"user": "Kehlani Foley",
"userId": "B9E7417A-00AA-4BC5-8DA4-E589CC04E1BF",
"companyId": "582C407F-4398-4F0A-AF67-4363D7CD7795",
"status": {
"userStatus": "Add Wage"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Kehlani",
"lastName": "Foley",
"middleName": "",
"phoneNumber": "2631213690",
"kycStatus": "new",
"jobTitle": "Manager",
"dateOfJoin": "2023-01-01",
"email": "foley1803hhhggffyffyufyugfugugiuhugygyftydrdtrdesessehssss@mailsac.com",
"userWages": [],
"userAddress": null
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.