Skip to main content
GET
/
config
Get Configuration
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/config \
  --header 'X-API-KEY: <api-key>'
{
  "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.
CategoryDescriptionSubcategories
shift_optionsShift behavior and limitsshift_requests, split_shifts, shift_equalizer, shift_visibility, worker_limits
worker_interactionWorker-facing featuresbailouts, availability, time_off, reviews_and_stars, blogs, coworker_display, calendar_sync
worker_communicationAutomated messagingautotext, web_checkin, silence_mode, text_communication, custom_messages, invite_to_work, event_updates
adminAdmin tools and displaydaily_summary, verbose_emails, list_view_options, list_view_verbose, worker_profile_control, publish_system, bailout_reason
time_trackingTime punch and payrolltime_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

​
X-API-KEY
string
header
required

Response

OK

Complete company configuration organized into five categories, plus a premium status flag. Each setting value is returned directly.

​
premium
boolean

Whether the company has premium features enabled.

​
shift_options
object

Settings controlling shift behavior: requests, split shifts, equalizer, visibility, and worker limits.

​
worker_interaction
object

Settings for worker-facing features: bailouts, availability, time off, reviews, blogs, coworker display, and calendar sync.

​
worker_communication
object

Settings for automated messaging: autotext solicitation, web check-in, silence mode, text options, custom messages, invitations, and event updates.

​
admin
object

Settings for admin tools: daily summaries, verbose emails, list view options, worker profile control, publish system, and bailout reasons.

​
time_tracking
object

Settings for time tracking: punch system, worker hours display, client sign-off, reimbursements, deductions, and personnel orders.