getUsers
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getUsers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getUsers",
"companyId": "CFC4D743-4869-4799-B1AF-B615D6CF21E5"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getUsers"
payload = {
"method": "getUsers",
"companyId": "CFC4D743-4869-4799-B1AF-B615D6CF21E5"
}
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: 'getUsers', companyId: 'CFC4D743-4869-4799-B1AF-B615D6CF21E5'})
};
fetch('https://sandbox.rollfi.xyz/reports/getUsers', 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/getUsers",
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' => 'getUsers',
'companyId' => 'CFC4D743-4869-4799-B1AF-B615D6CF21E5'
]),
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/getUsers"
payload := strings.NewReader("{\n \"method\": \"getUsers\",\n \"companyId\": \"CFC4D743-4869-4799-B1AF-B615D6CF21E5\"\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/getUsers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getUsers\",\n \"companyId\": \"CFC4D743-4869-4799-B1AF-B615D6CF21E5\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getUsers")
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\": \"getUsers\",\n \"companyId\": \"CFC4D743-4869-4799-B1AF-B615D6CF21E5\"\n}"
response = http.request(request)
puts response.read_body{
"users": [
{
"user": "Molly Phelps",
"userId": "A9A61FBE-7C7F-48E6-9CA8-1AD8A8CB3980",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"status": {
"userStatus": "Active"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Molly",
"lastName": "Phelps",
"middleName": "",
"phoneNumber": "9988776655",
"kycStatus": "passed",
"jobTitle": "Developer",
"dateOfJoin": "2023-02-02",
"email": "phelps6600@mailsac.com",
"userWages": [
{
"WageRate": 4000,
"WageBasis": {
"WageBasis": "Per Month"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
}
}
],
"userAddress": {
"address1": "102 Fallsgrove Blvd",
"address2": "",
"city": "Seattle",
"state": "WA",
"zipcode": "98101",
"country": "US"
},
"employeeMiscellaneousStateTax": {
"RiskClassCode": "643609",
"CompositeRate": "9",
"RiskClassNameEmployee": "Plumber",
"PayrollDeductionRate": "4.5"
}
}
]
}{
"error": {
"code": 400,
"message": "Invalid CompanyId"
}
}Reports
getUsers
The getUsers API retrieves detailed information for all users within a company.
What it does:
- Returns comprehensive user details for all employees (W2) and contractors (1099) including personal information, employment status, wage, and contact data
- Provides complete user profile information for all active users in the company
Note:
- Sensitive data, such as bank details, are ommitted from the blanket
getUsersand must be retrieved individually
GET
/
reports
/
getUsers
getUsers
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getUsers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getUsers",
"companyId": "CFC4D743-4869-4799-B1AF-B615D6CF21E5"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getUsers"
payload = {
"method": "getUsers",
"companyId": "CFC4D743-4869-4799-B1AF-B615D6CF21E5"
}
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: 'getUsers', companyId: 'CFC4D743-4869-4799-B1AF-B615D6CF21E5'})
};
fetch('https://sandbox.rollfi.xyz/reports/getUsers', 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/getUsers",
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' => 'getUsers',
'companyId' => 'CFC4D743-4869-4799-B1AF-B615D6CF21E5'
]),
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/getUsers"
payload := strings.NewReader("{\n \"method\": \"getUsers\",\n \"companyId\": \"CFC4D743-4869-4799-B1AF-B615D6CF21E5\"\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/getUsers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getUsers\",\n \"companyId\": \"CFC4D743-4869-4799-B1AF-B615D6CF21E5\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getUsers")
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\": \"getUsers\",\n \"companyId\": \"CFC4D743-4869-4799-B1AF-B615D6CF21E5\"\n}"
response = http.request(request)
puts response.read_body{
"users": [
{
"user": "Molly Phelps",
"userId": "A9A61FBE-7C7F-48E6-9CA8-1AD8A8CB3980",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"status": {
"userStatus": "Active"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Molly",
"lastName": "Phelps",
"middleName": "",
"phoneNumber": "9988776655",
"kycStatus": "passed",
"jobTitle": "Developer",
"dateOfJoin": "2023-02-02",
"email": "phelps6600@mailsac.com",
"userWages": [
{
"WageRate": 4000,
"WageBasis": {
"WageBasis": "Per Month"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
}
}
],
"userAddress": {
"address1": "102 Fallsgrove Blvd",
"address2": "",
"city": "Seattle",
"state": "WA",
"zipcode": "98101",
"country": "US"
},
"employeeMiscellaneousStateTax": {
"RiskClassCode": "643609",
"CompositeRate": "9",
"RiskClassNameEmployee": "Plumber",
"PayrollDeductionRate": "4.5"
}
}
]
}{
"error": {
"code": 400,
"message": "Invalid CompanyId"
}
}⌘I
