getActiveUsers
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getActiveUsers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getActiveUsers",
"companyId": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"workerType": "W2"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getActiveUsers"
payload = {
"method": "getActiveUsers",
"companyId": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"workerType": "W2"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getActiveUsers',
companyId: '01A33366-EE1C-4E13-BCB9-E482AC3A4545',
workerType: 'W2'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getActiveUsers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/reports/getActiveUsers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getActiveUsers',
'companyId' => '01A33366-EE1C-4E13-BCB9-E482AC3A4545',
'workerType' => 'W2'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/reports/getActiveUsers"
payload := strings.NewReader("{\n \"method\": \"getActiveUsers\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\",\n \"workerType\": \"W2\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.rollfi.xyz/reports/getActiveUsers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getActiveUsers\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\",\n \"workerType\": \"W2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getActiveUsers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getActiveUsers\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\",\n \"workerType\": \"W2\"\n}"
response = http.request(request)
puts response.read_body{
"user": [
{
"user": "Ryan Lee Allen",
"userId": "94380CA2-3612-46D7-92EA-02D8A2D0A094",
"userReferenceId": "",
"companyId": "B35D7C33-93EF-44EB-8C04-6BBD0907CCB4",
"status": {
"userStatus": "Active"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Ryan",
"lastName": "Allen",
"middleName": "Lee",
"phoneNumber": "6449847893",
"kycStatus": "passed",
"jobTitle": "Maintenance Technician",
"dateOfJoin": "2025-11-14",
"email": "ryan.allen70819@mailsac.com",
"userWages": [
{
"WageRate": 25,
"WageBasis": {
"WageBasis": "Per Day"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
}
}
],
"userAddress": {
"address1": "1725 Reisterstown Rd",
"address2": "",
"city": "Randallstown",
"state": "MD",
"zipcode": "21133",
"country": "US"
}
}
]
}Reports
getActiveUsers
The getActiveUsers API is used to retrieve comprehensive information about all currently active users in the system. This report provides essential user data for payroll processing, compliance tracking, and workforce management.
What it does:
- Returns detailed information for active users including wage and address
Notes:
- Only active users are fetched by this API call. Deactivated or terminated users will not appear in the results
- Requests are worker type specific (W2 for employees and 1099 for contractors)
- Returns the same fields as
getUsers, which can be used to retrieve a full list of activated, deactivated and terminated users
GET
/
reports
/
getActiveUsers
getActiveUsers
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getActiveUsers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getActiveUsers",
"companyId": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"workerType": "W2"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getActiveUsers"
payload = {
"method": "getActiveUsers",
"companyId": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"workerType": "W2"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getActiveUsers',
companyId: '01A33366-EE1C-4E13-BCB9-E482AC3A4545',
workerType: 'W2'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getActiveUsers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/reports/getActiveUsers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getActiveUsers',
'companyId' => '01A33366-EE1C-4E13-BCB9-E482AC3A4545',
'workerType' => 'W2'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/reports/getActiveUsers"
payload := strings.NewReader("{\n \"method\": \"getActiveUsers\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\",\n \"workerType\": \"W2\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.rollfi.xyz/reports/getActiveUsers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getActiveUsers\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\",\n \"workerType\": \"W2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getActiveUsers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getActiveUsers\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\",\n \"workerType\": \"W2\"\n}"
response = http.request(request)
puts response.read_body{
"user": [
{
"user": "Ryan Lee Allen",
"userId": "94380CA2-3612-46D7-92EA-02D8A2D0A094",
"userReferenceId": "",
"companyId": "B35D7C33-93EF-44EB-8C04-6BBD0907CCB4",
"status": {
"userStatus": "Active"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Ryan",
"lastName": "Allen",
"middleName": "Lee",
"phoneNumber": "6449847893",
"kycStatus": "passed",
"jobTitle": "Maintenance Technician",
"dateOfJoin": "2025-11-14",
"email": "ryan.allen70819@mailsac.com",
"userWages": [
{
"WageRate": 25,
"WageBasis": {
"WageBasis": "Per Day"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
}
}
],
"userAddress": {
"address1": "1725 Reisterstown Rd",
"address2": "",
"city": "Randallstown",
"state": "MD",
"zipcode": "21133",
"country": "US"
}
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Response
200 - application/json
Show child attributes
Show child attributes
⌘I
