Configuration
Get Configuration
Returns all configuration settings for your company, organized into five categories: shift options, worker interaction, worker communication, admin, and time tracking.
GET
/
config
Get Configuration
curl --request GET \
--url https://api.roostedhr.com/api/1_12/config \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.roostedhr.com/api/1_12/config"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.roostedhr.com/api/1_12/config', 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://api.roostedhr.com/api/1_12/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.roostedhr.com/api/1_12/config"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.roostedhr.com/api/1_12/config")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"premium": true,
"shift_options": {
"shift_requests": {
"active": 0,
"comments_active": 0,
"email_toolkits_on_request": 0,
"text_approval": 0,
"text_rejection": 0,
"text_request_overage_percent": 0,
"text_requests_active": 0
},
"split_shifts": {
"active": 0,
"active_customized": 0,
"endless_ern_hour_assumption": 123
},
"shift_equalizer": {
"active": 0
},
"shift_visibility": {
"active": 0,
"hide_shift_times": 0,
"defaultDaysOut": 123,
"visibility_limited": 0,
"visibility_limited_customized": 0,
"display_full_location": 0
},
"worker_limits": {
"soft_worker_hour_limit": 123,
"soft_worker_hour_limit_min_period": 123,
"hard_worker_hour_limit": 123,
"soft_worker_shift_limit": 123,
"soft_worker_shift_limit_min_period": 123,
"hard_worker_shift_limit": 123
}
},
"worker_interaction": {
"bailouts": {
"bailouts_active": 0,
"bailouts_customized": 0,
"bailouts_email_max": 123,
"bailouts_min": 123,
"bailouts_show_hr_email": 0,
"bailouts_warning_message": "<string>",
"bailouts_request_bailout_allowed": 0,
"bailouts_request_bailout_not_allowed": 0
},
"availability": {
"active": 0,
"block_autotext": 0,
"block_signup": 0,
"lock_within": 0,
"needs_approval": 0
},
"time_off": {
"active": 0,
"types_required": 0
},
"reviews_and_stars": {
"reviews_hidden": 0,
"stars_hidden": 0,
"stars_hidden_full": 0
},
"blogs": {
"active": 0
},
"coworker_display": {
"display_c_emails": 0,
"display_c_numbers": 0,
"display_c_whole_shift": 0,
"display_c_skillsets": 0,
"display_coworkers": 0
},
"calendar_sync": {
"worker_calendar_active": 0,
"worker_calendar_reviewer_and_timetracking_calendar": 0,
"admin_calendar_active": 0
}
},
"worker_communication": {
"autotext": {
"active": 0,
"blackout_before": {
"hour": 123,
"minute": 123
},
"blackout_after": {
"hour": 123,
"minute": 123
},
"hoursBeforeAutoSolicitation": 123,
"locked_default": 0,
"no_text_declines": 0
},
"web_checkin": {
"active": 0,
"checkin_text_active": 0,
"comments": 0,
"hours_before_event": 123,
"hours_before_summary": 123,
"web_checkin_customized": 0,
"additional_checkins": [
{}
]
},
"silence_mode": {
"active": 0
},
"text_communication": {
"alternate_added": 0,
"alternate_removed": 0,
"alternate_upgraded": 0,
"clock_in_forgotten": 0,
"clock_in_forgotten_minutes_after_shift_start": 123,
"clock_in_reminder": 0,
"clock_in_reminder_minutes_before_shift_start": 123,
"clock_out_forgotten": 0,
"clock_out_forgotten_minutes_after_shift_end": 123,
"clock_out_reminder": 0,
"clock_out_soon_reminder": 0,
"clock_out_soon_reminder_minutes_before_shift_end": 123,
"shift_added": 0,
"shift_removed": 0
},
"custom_messages": {
"account_status_error": "<string>"
},
"invite_to_work": {
"email_admin_acceptance": 0,
"email_admin_failure": 0,
"email_invite": 0,
"text_invite": 0
},
"event_updates": {
"active": 0,
"reviewer_update": 0,
"text_active": 0,
"text_limited": 0,
"text_limited_timeframe": 123
}
},
"admin": {
"daily_summary": {
"active": 0,
"active_customized": 0,
"day_of_the_week": 123
},
"verbose_emails": {
"active": 0,
"addRoleComments": 0,
"addWholeShiftComments": 0,
"hidePersonnelEmail": 0,
"hidePersonnelPhone": 0
},
"list_view_options": {
"high_visibility": 0,
"ampm": 0,
"default_tab": 123
},
"list_view_verbose": {
"active": 0,
"email": 0,
"full_location": 0,
"phone": 0,
"reviewer": 0,
"shift_comments": 0,
"toolkit_comments": 0
},
"worker_profile_control": {
"address_locked": 0,
"email_locked": 0,
"name_locked": 0,
"number_locked": 0,
"photo_locked": 0
},
"publish_system": {
"published": 0,
"text_publish": 0,
"email_publish": 0
},
"bailout_reason": {
"reason_required": 0
}
},
"time_tracking": {
"time_tracking": {
"preapprove_punches": 0,
"reviewer_punch_in_out": 0,
"take_picture": 0,
"require_picture_with_punch": 0,
"get_location": 0,
"distance_limited": 0,
"time_punch_max_distance": 123,
"free_clock_location_required": 0,
"start_hard_time_lock": 0,
"max_early_clock_in": 123,
"end_hard_time_lock": 0,
"max_late_clock_out": 123,
"fiscal_start_of_week": 123,
"max_continuous_shift_time": 123,
"ampm": 0,
"allow_worker_edit_requests": 0,
"worker_signoff_event_time_punches": 0,
"worker_signoff_checkbox": 0,
"worker_signoff_checkbox_title": "<string>",
"worker_signoff_checkbox_description": "<string>",
"worker_allowed_punches": 0,
"worker_allowed_web_punches": 0,
"daily_overtime_hours": 123,
"daily_doubletime_hours": 123,
"weekly_overtime_hours": 123,
"weekly_doubletime_hours": 123,
"fiscal_pay_period_type": "Weekly",
"fiscal_every_2_weeks_start": "<string>"
},
"show_workers_hours": {
"active": 0,
"show_expected_hours": 0,
"endless_use_multiple_shifts_assumption": 0
},
"client_sign": {
"active": 0,
"email_client_timesheets_on_signature": 0,
"email_reviewer_timesheets_on_signature": 0,
"email_timetracking_manager_timesheets_on_signature": 0,
"email_owners_timesheets_on_signature": 0,
"email_admins_timesheets_on_signature": 0,
"email_timesheets_on_signature_include_individual_punches": 0
},
"reimbursements": {
"active": 0,
"allow_worker_viewing": 0,
"allow_worker_submission": 0,
"require_picture_with_mileage": 0,
"require_picture_with_reimbursement": 0,
"require_picture_with_mileage_for_admins": 0,
"require_picture_with_reimbursement_for_admins": 0
},
"deductions": {
"active": 0,
"deductions": [
{}
]
},
"personnel_orders": {
"active": 0,
"orderables": [
{}
]
}
}
}Returns all configuration settings for your company. The response is organized into five top-level categories, each containing subcategories of individual settings.
| Category | Description | Subcategories |
|---|---|---|
shift_options | Shift behavior and limits | shift_requests, split_shifts, shift_equalizer, shift_visibility, worker_limits |
worker_interaction | Worker-facing features | bailouts, availability, time_off, reviews_and_stars, blogs, coworker_display, calendar_sync |
worker_communication | Automated messaging | autotext, web_checkin, silence_mode, text_communication, custom_messages, invite_to_work, event_updates |
admin | Admin tools and display | daily_summary, verbose_emails, list_view_options, list_view_verbose, worker_profile_control, publish_system, bailout_reason |
time_tracking | Time punch and payroll | time_tracking, show_workers_hours, client_sign, reimbursements, deductions, personnel_orders |
The top-level
premium boolean indicates whether the company has premium features enabled. The personnel_orders subcategory contains the list of orderable items used by the Create Worker Order endpoint.Authorizations
Response
OK
Complete company configuration organized into five categories, plus a premium status flag. Each setting value is returned directly.
Whether the company has premium features enabled.
Settings controlling shift behavior: requests, split shifts, equalizer, visibility, and worker limits.
Show child attributes
Show child attributes
Settings for worker-facing features: bailouts, availability, time off, reviews, blogs, coworker display, and calendar sync.
Show child attributes
Show child attributes
Settings for automated messaging: autotext solicitation, web check-in, silence mode, text options, custom messages, invitations, and event updates.
Show child attributes
Show child attributes
Settings for admin tools: daily summaries, verbose emails, list view options, worker profile control, publish system, and bailout reasons.
Show child attributes
Show child attributes
Settings for time tracking: punch system, worker hours display, client sign-off, reimbursements, deductions, and personnel orders.
Show child attributes
Show child attributes
⌘I
Get Configuration
curl --request GET \
--url https://api.roostedhr.com/api/1_12/config \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.roostedhr.com/api/1_12/config"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.roostedhr.com/api/1_12/config', 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://api.roostedhr.com/api/1_12/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.roostedhr.com/api/1_12/config"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.roostedhr.com/api/1_12/config")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"premium": true,
"shift_options": {
"shift_requests": {
"active": 0,
"comments_active": 0,
"email_toolkits_on_request": 0,
"text_approval": 0,
"text_rejection": 0,
"text_request_overage_percent": 0,
"text_requests_active": 0
},
"split_shifts": {
"active": 0,
"active_customized": 0,
"endless_ern_hour_assumption": 123
},
"shift_equalizer": {
"active": 0
},
"shift_visibility": {
"active": 0,
"hide_shift_times": 0,
"defaultDaysOut": 123,
"visibility_limited": 0,
"visibility_limited_customized": 0,
"display_full_location": 0
},
"worker_limits": {
"soft_worker_hour_limit": 123,
"soft_worker_hour_limit_min_period": 123,
"hard_worker_hour_limit": 123,
"soft_worker_shift_limit": 123,
"soft_worker_shift_limit_min_period": 123,
"hard_worker_shift_limit": 123
}
},
"worker_interaction": {
"bailouts": {
"bailouts_active": 0,
"bailouts_customized": 0,
"bailouts_email_max": 123,
"bailouts_min": 123,
"bailouts_show_hr_email": 0,
"bailouts_warning_message": "<string>",
"bailouts_request_bailout_allowed": 0,
"bailouts_request_bailout_not_allowed": 0
},
"availability": {
"active": 0,
"block_autotext": 0,
"block_signup": 0,
"lock_within": 0,
"needs_approval": 0
},
"time_off": {
"active": 0,
"types_required": 0
},
"reviews_and_stars": {
"reviews_hidden": 0,
"stars_hidden": 0,
"stars_hidden_full": 0
},
"blogs": {
"active": 0
},
"coworker_display": {
"display_c_emails": 0,
"display_c_numbers": 0,
"display_c_whole_shift": 0,
"display_c_skillsets": 0,
"display_coworkers": 0
},
"calendar_sync": {
"worker_calendar_active": 0,
"worker_calendar_reviewer_and_timetracking_calendar": 0,
"admin_calendar_active": 0
}
},
"worker_communication": {
"autotext": {
"active": 0,
"blackout_before": {
"hour": 123,
"minute": 123
},
"blackout_after": {
"hour": 123,
"minute": 123
},
"hoursBeforeAutoSolicitation": 123,
"locked_default": 0,
"no_text_declines": 0
},
"web_checkin": {
"active": 0,
"checkin_text_active": 0,
"comments": 0,
"hours_before_event": 123,
"hours_before_summary": 123,
"web_checkin_customized": 0,
"additional_checkins": [
{}
]
},
"silence_mode": {
"active": 0
},
"text_communication": {
"alternate_added": 0,
"alternate_removed": 0,
"alternate_upgraded": 0,
"clock_in_forgotten": 0,
"clock_in_forgotten_minutes_after_shift_start": 123,
"clock_in_reminder": 0,
"clock_in_reminder_minutes_before_shift_start": 123,
"clock_out_forgotten": 0,
"clock_out_forgotten_minutes_after_shift_end": 123,
"clock_out_reminder": 0,
"clock_out_soon_reminder": 0,
"clock_out_soon_reminder_minutes_before_shift_end": 123,
"shift_added": 0,
"shift_removed": 0
},
"custom_messages": {
"account_status_error": "<string>"
},
"invite_to_work": {
"email_admin_acceptance": 0,
"email_admin_failure": 0,
"email_invite": 0,
"text_invite": 0
},
"event_updates": {
"active": 0,
"reviewer_update": 0,
"text_active": 0,
"text_limited": 0,
"text_limited_timeframe": 123
}
},
"admin": {
"daily_summary": {
"active": 0,
"active_customized": 0,
"day_of_the_week": 123
},
"verbose_emails": {
"active": 0,
"addRoleComments": 0,
"addWholeShiftComments": 0,
"hidePersonnelEmail": 0,
"hidePersonnelPhone": 0
},
"list_view_options": {
"high_visibility": 0,
"ampm": 0,
"default_tab": 123
},
"list_view_verbose": {
"active": 0,
"email": 0,
"full_location": 0,
"phone": 0,
"reviewer": 0,
"shift_comments": 0,
"toolkit_comments": 0
},
"worker_profile_control": {
"address_locked": 0,
"email_locked": 0,
"name_locked": 0,
"number_locked": 0,
"photo_locked": 0
},
"publish_system": {
"published": 0,
"text_publish": 0,
"email_publish": 0
},
"bailout_reason": {
"reason_required": 0
}
},
"time_tracking": {
"time_tracking": {
"preapprove_punches": 0,
"reviewer_punch_in_out": 0,
"take_picture": 0,
"require_picture_with_punch": 0,
"get_location": 0,
"distance_limited": 0,
"time_punch_max_distance": 123,
"free_clock_location_required": 0,
"start_hard_time_lock": 0,
"max_early_clock_in": 123,
"end_hard_time_lock": 0,
"max_late_clock_out": 123,
"fiscal_start_of_week": 123,
"max_continuous_shift_time": 123,
"ampm": 0,
"allow_worker_edit_requests": 0,
"worker_signoff_event_time_punches": 0,
"worker_signoff_checkbox": 0,
"worker_signoff_checkbox_title": "<string>",
"worker_signoff_checkbox_description": "<string>",
"worker_allowed_punches": 0,
"worker_allowed_web_punches": 0,
"daily_overtime_hours": 123,
"daily_doubletime_hours": 123,
"weekly_overtime_hours": 123,
"weekly_doubletime_hours": 123,
"fiscal_pay_period_type": "Weekly",
"fiscal_every_2_weeks_start": "<string>"
},
"show_workers_hours": {
"active": 0,
"show_expected_hours": 0,
"endless_use_multiple_shifts_assumption": 0
},
"client_sign": {
"active": 0,
"email_client_timesheets_on_signature": 0,
"email_reviewer_timesheets_on_signature": 0,
"email_timetracking_manager_timesheets_on_signature": 0,
"email_owners_timesheets_on_signature": 0,
"email_admins_timesheets_on_signature": 0,
"email_timesheets_on_signature_include_individual_punches": 0
},
"reimbursements": {
"active": 0,
"allow_worker_viewing": 0,
"allow_worker_submission": 0,
"require_picture_with_mileage": 0,
"require_picture_with_reimbursement": 0,
"require_picture_with_mileage_for_admins": 0,
"require_picture_with_reimbursement_for_admins": 0
},
"deductions": {
"active": 0,
"deductions": [
{}
]
},
"personnel_orders": {
"active": 0,
"orderables": [
{}
]
}
}
}