getBusinessUsers
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getBusinessUsers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getBusinessUsers",
"companyId": "B62B4EB2-4198-42FE-95E3-00959BEF1B8F"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getBusinessUsers"
payload = {
"method": "getBusinessUsers",
"companyId": "B62B4EB2-4198-42FE-95E3-00959BEF1B8F"
}
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: 'getBusinessUsers', companyId: 'B62B4EB2-4198-42FE-95E3-00959BEF1B8F'})
};
fetch('https://sandbox.rollfi.xyz/reports/getBusinessUsers', 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/getBusinessUsers",
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' => 'getBusinessUsers',
'companyId' => 'B62B4EB2-4198-42FE-95E3-00959BEF1B8F'
]),
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/getBusinessUsers"
payload := strings.NewReader("{\n \"method\": \"getBusinessUsers\",\n \"companyId\": \"B62B4EB2-4198-42FE-95E3-00959BEF1B8F\"\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/getBusinessUsers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getBusinessUsers\",\n \"companyId\": \"B62B4EB2-4198-42FE-95E3-00959BEF1B8F\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getBusinessUsers")
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\": \"getBusinessUsers\",\n \"companyId\": \"B62B4EB2-4198-42FE-95E3-00959BEF1B8F\"\n}"
response = http.request(request)
puts response.read_body{
"BusinessUser": [
{
"businessUserId": "F7F09EAD-2FA8-458F-B3E6-750F42B15857",
"businessUser": "Tyler Hm",
"firstName": "Tyler",
"middleName": "",
"lastName": "Hm",
"email": "tylerhm@mailsac.com",
"phoneNumber": "8473625628",
"payrollAdmin": true,
"bookKeeper": true,
"beneficialOwner": true,
"employee": false,
"ownershipPercentage": 0.1,
"companyLocationID": "F7F09EAD-2FA8-458F-B3E6-750F42B15857",
"address1": "919 2nd Ave",
"address2": "",
"city": "New York",
"state": "NY",
"zipcode": "10017-1582",
"country": "US",
"ssn": "857476277",
"startDate": "2023-12-10",
"dateOfBirth": "2000-12-10"
}
]
}Reports
getBusinessUsers
The getBusinessUsers API is used to retrieve comprehensive information about all business users within a company.
What it does:
- Returns the business user IDs for every business user in the payroll system
- Returns detailed information for each of the business users including their role, address, SSN and more
Notes:
- Requires only a companyID since all business users are retrieved
- Returns the same fields as
getBusinessUserInfowhich can be used to retrieve data for a single business user
GET
/
reports
/
getBusinessUsers
getBusinessUsers
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getBusinessUsers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getBusinessUsers",
"companyId": "B62B4EB2-4198-42FE-95E3-00959BEF1B8F"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getBusinessUsers"
payload = {
"method": "getBusinessUsers",
"companyId": "B62B4EB2-4198-42FE-95E3-00959BEF1B8F"
}
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: 'getBusinessUsers', companyId: 'B62B4EB2-4198-42FE-95E3-00959BEF1B8F'})
};
fetch('https://sandbox.rollfi.xyz/reports/getBusinessUsers', 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/getBusinessUsers",
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' => 'getBusinessUsers',
'companyId' => 'B62B4EB2-4198-42FE-95E3-00959BEF1B8F'
]),
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/getBusinessUsers"
payload := strings.NewReader("{\n \"method\": \"getBusinessUsers\",\n \"companyId\": \"B62B4EB2-4198-42FE-95E3-00959BEF1B8F\"\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/getBusinessUsers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getBusinessUsers\",\n \"companyId\": \"B62B4EB2-4198-42FE-95E3-00959BEF1B8F\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getBusinessUsers")
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\": \"getBusinessUsers\",\n \"companyId\": \"B62B4EB2-4198-42FE-95E3-00959BEF1B8F\"\n}"
response = http.request(request)
puts response.read_body{
"BusinessUser": [
{
"businessUserId": "F7F09EAD-2FA8-458F-B3E6-750F42B15857",
"businessUser": "Tyler Hm",
"firstName": "Tyler",
"middleName": "",
"lastName": "Hm",
"email": "tylerhm@mailsac.com",
"phoneNumber": "8473625628",
"payrollAdmin": true,
"bookKeeper": true,
"beneficialOwner": true,
"employee": false,
"ownershipPercentage": 0.1,
"companyLocationID": "F7F09EAD-2FA8-458F-B3E6-750F42B15857",
"address1": "919 2nd Ave",
"address2": "",
"city": "New York",
"state": "NY",
"zipcode": "10017-1582",
"country": "US",
"ssn": "857476277",
"startDate": "2023-12-10",
"dateOfBirth": "2000-12-10"
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
200 - application/json
Show child attributes
Show child attributes
⌘I
