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
GetUsersByCompanyName
GET
/
reports#getUsersByCompanyName
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getUsersByCompanyName' \
--header 'Content-Type: application/json' \
--data '{
"method": "getUsersByCompanyName",
"companyName": "3M"
}'
{
"summary": "Success",
"value": {
"users": [
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "F4481532-51B0-4405-93E1-174FFA270AB7",
"user": "Scarlett Orr",
"firstName": "Scarlett",
"middleName": "",
"lastName": "Orr",
"email": "scarlett123@mailsac.com",
"dateOfJoin": "2023-08-23",
"jobTitle": "HR",
"kycStatus": "passed",
"phoneNumber": "8965886658",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "D91B2B72-66D5-49DC-9C79-41F983135D91",
"user": "Robin Orr",
"firstName": "Robin",
"middleName": "",
"lastName": "Orr",
"email": "robin1234@mailsac.com",
"dateOfJoin": "2023-09-11",
"jobTitle": "HR",
"kycStatus": "passed",
"phoneNumber": "4569745665",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "5E704B63-FD22-4444-964A-4C4C90D6C545",
"user": "Santos Howard",
"firstName": "Santos",
"middleName": "",
"lastName": "Howard",
"email": "santos123@mailsac.com",
"dateOfJoin": "2024-07-21",
"jobTitle": "HR",
"kycStatus": "passed",
"phoneNumber": "7896325410",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "80316182-54F6-479F-9DE0-5BA8AC214849",
"user": "Grey Nancy",
"firstName": "Grey",
"middleName": "",
"lastName": "Nancy",
"email": "greynancy7748@mailsac.com",
"dateOfJoin": "2024-02-02",
"jobTitle": "HR",
"kycStatus": "pending",
"phoneNumber": "8444144414",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "D864FBC7-AF7B-4C5C-B000-9FA11668721A",
"user": "Otis Price",
"firstName": "Otis",
"middleName": "",
"lastName": "Price",
"email": "otis123@mailsac.com",
"dateOfJoin": "2024-06-21",
"jobTitle": "QA",
"kycStatus": "passed",
"phoneNumber": "7896546322",
"workerType": {
"workerType": "1099-NEC"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "DB14C767-4C87-479D-8752-CB31E1EDD067",
"user": "Edi Beccker",
"firstName": "Edi",
"middleName": "",
"lastName": "Beccker",
"email": "edibecker@mailsac.com",
"dateOfJoin": "2024-02-02",
"jobTitle": "HR",
"kycStatus": "pending",
"phoneNumber": "0478954152",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "E2DA74E1-1D03-4235-ADBD-CB508FF58513",
"user": "Onyx Maddox",
"firstName": "Onyx",
"middleName": "",
"lastName": "Maddox",
"email": "onyx123@mailsac.com",
"dateOfJoin": "2023-08-21",
"jobTitle": "HR",
"kycStatus": "passed",
"phoneNumber": "7896552324",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "BECE2900-6169-4514-AC12-DDC8CD90A953",
"user": "Emily Orr",
"firstName": "Emily",
"middleName": "",
"lastName": "Orr",
"email": "emily123@mailsac.com",
"dateOfJoin": "2023-08-23",
"jobTitle": "HR",
"kycStatus": "passed",
"phoneNumber": "0233699856",
"workerType": {
"workerType": "W2"
}
}
]
}
}
Body
application/json
Example:
["getUsersByCompanyName"]
Response
200 - application/json
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getUsersByCompanyName' \
--header 'Content-Type: application/json' \
--data '{
"method": "getUsersByCompanyName",
"companyName": "3M"
}'
{
"summary": "Success",
"value": {
"users": [
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "F4481532-51B0-4405-93E1-174FFA270AB7",
"user": "Scarlett Orr",
"firstName": "Scarlett",
"middleName": "",
"lastName": "Orr",
"email": "scarlett123@mailsac.com",
"dateOfJoin": "2023-08-23",
"jobTitle": "HR",
"kycStatus": "passed",
"phoneNumber": "8965886658",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "D91B2B72-66D5-49DC-9C79-41F983135D91",
"user": "Robin Orr",
"firstName": "Robin",
"middleName": "",
"lastName": "Orr",
"email": "robin1234@mailsac.com",
"dateOfJoin": "2023-09-11",
"jobTitle": "HR",
"kycStatus": "passed",
"phoneNumber": "4569745665",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "5E704B63-FD22-4444-964A-4C4C90D6C545",
"user": "Santos Howard",
"firstName": "Santos",
"middleName": "",
"lastName": "Howard",
"email": "santos123@mailsac.com",
"dateOfJoin": "2024-07-21",
"jobTitle": "HR",
"kycStatus": "passed",
"phoneNumber": "7896325410",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "80316182-54F6-479F-9DE0-5BA8AC214849",
"user": "Grey Nancy",
"firstName": "Grey",
"middleName": "",
"lastName": "Nancy",
"email": "greynancy7748@mailsac.com",
"dateOfJoin": "2024-02-02",
"jobTitle": "HR",
"kycStatus": "pending",
"phoneNumber": "8444144414",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "D864FBC7-AF7B-4C5C-B000-9FA11668721A",
"user": "Otis Price",
"firstName": "Otis",
"middleName": "",
"lastName": "Price",
"email": "otis123@mailsac.com",
"dateOfJoin": "2024-06-21",
"jobTitle": "QA",
"kycStatus": "passed",
"phoneNumber": "7896546322",
"workerType": {
"workerType": "1099-NEC"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "DB14C767-4C87-479D-8752-CB31E1EDD067",
"user": "Edi Beccker",
"firstName": "Edi",
"middleName": "",
"lastName": "Beccker",
"email": "edibecker@mailsac.com",
"dateOfJoin": "2024-02-02",
"jobTitle": "HR",
"kycStatus": "pending",
"phoneNumber": "0478954152",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "E2DA74E1-1D03-4235-ADBD-CB508FF58513",
"user": "Onyx Maddox",
"firstName": "Onyx",
"middleName": "",
"lastName": "Maddox",
"email": "onyx123@mailsac.com",
"dateOfJoin": "2023-08-21",
"jobTitle": "HR",
"kycStatus": "passed",
"phoneNumber": "7896552324",
"workerType": {
"workerType": "W2"
}
},
{
"companyID": "07D6D507-8764-4CD2-818E-D64CF554D018",
"userID": "BECE2900-6169-4514-AC12-DDC8CD90A953",
"user": "Emily Orr",
"firstName": "Emily",
"middleName": "",
"lastName": "Orr",
"email": "emily123@mailsac.com",
"dateOfJoin": "2023-08-23",
"jobTitle": "HR",
"kycStatus": "passed",
"phoneNumber": "0233699856",
"workerType": {
"workerType": "W2"
}
}
]
}
}