> ## Documentation Index > Fetch the complete documentation index at: https://docs.roostedhr.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Configuration > Returns all configuration settings for your company, organized into five categories: shift options, worker interaction, worker communication, admin, and time tracking. 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](/api-reference/v01.12.00/workers/create-worker-order) endpoint. ## OpenAPI ````yaml api-reference/v01.12.00/openapi-v01.12.00.json GET /config openapi: 3.0.0 info: title: Roosted version: 0.1.12 contact: name: Support url: https://support.roostedhr.com/support/home email: support@roostedhr.com description: |- Enterprise API Sandbox keys and Production keys are requested from support servers: - url: https://api.roostedhr.com/api/1_12 - url: https://sandbox.roostedhr.com/api/1_12 security: - X-API-KEY: [] tags: - name: Announcements - name: Areas - name: Clients - name: Company - name: Configuration - name: Events - name: Locations - name: Payroll Groups - name: Rate Cards - name: Shifts - name: Skillsets - name: Time Tracking - name: Wage Rules - name: Workers paths: /config: get: tags: - Configuration summary: Get Configuration description: >- Returns all configuration settings for your company, organized into five categories: shift options, worker interaction, worker communication, admin, and time tracking. operationId: get-config responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ConfigurationResponse' '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string description: Machine-readable error code. error: type: string description: Human-readable error message. examples: Invalid category: value: code: CFG-100 error: Invalid category Invalid subcategory: value: code: CFG-200 error: Invalid subcategory for the specified category Invalid item: value: code: CFG-300 error: Invalid item for the specified subcategory Invalid value: value: code: CFG-400 error: Invalid value for the specified item Category required: value: code: CFG-500 error: Category is required Subcategory required: value: code: CFG-600 error: Subcategory is required Item required: value: code: CFG-700 error: Item is required Value required: value: code: CFG-800 error: Value is required '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string description: Machine-readable error code. error: type: string description: Human-readable error message. examples: Invalid API key: value: code: ATH-100 error: Invalid or missing API key '403': description: Forbidden content: application/json: schema: type: object properties: code: type: string description: Machine-readable error code. error: type: string description: Human-readable error message. examples: Insufficient permissions: value: code: CFG-900 error: Insufficient permissions to manage configuration '404': description: Not Found content: application/json: schema: type: object properties: code: type: string description: Machine-readable error code. error: type: string description: Human-readable error message. examples: Resource not found: value: code: CFG-1100 error: Resource not found '500': description: Internal Server Error content: application/json: schema: type: object properties: code: type: string description: Machine-readable error code. error: type: string description: Human-readable error message. examples: Internal server error: value: code: CFG-1000 error: An unexpected error occurred components: schemas: ConfigurationResponse: title: ConfigurationResponse type: object description: >- Complete company configuration organized into five categories, plus a premium status flag. Each setting value is returned directly. properties: premium: type: boolean description: Whether the company has premium features enabled. shift_options: type: object description: >- Settings controlling shift behavior: requests, split shifts, equalizer, visibility, and worker limits. properties: shift_requests: type: object description: >- Controls whether workers can request shifts, text notifications for requests, and overage thresholds. properties: active: type: integer enum: - 0 - 1 description: Whether shift requests are enabled. comments_active: type: integer enum: - 0 - 1 description: Whether comments on shift requests are enabled. email_toolkits_on_request: type: integer enum: - 0 - 1 description: Whether to email toolkit admins when a request is made. text_approval: type: integer enum: - 0 - 1 description: Whether to text workers on shift request approval. text_rejection: type: integer enum: - 0 - 1 description: Whether to text workers on shift request rejection. text_request_overage_percent: type: integer enum: - 0 - 1 description: >- Whether to text when shift requests exceed the overage threshold. text_requests_active: type: integer enum: - 0 - 1 description: Whether text-based shift requesting is enabled. split_shifts: type: object description: Controls split/multiple shift functionality and customization. properties: active: type: integer enum: - 0 - 1 description: Whether split shifts are enabled. active_customized: type: integer enum: - 0 - 1 description: Whether customized split shift settings are enabled. endless_ern_hour_assumption: type: number description: Assumed hours for open-ended shifts when calculating splits. shift_equalizer: type: object description: Controls automatic shift distribution balancing. properties: active: type: integer enum: - 0 - 1 description: Whether the shift equalizer is enabled. shift_visibility: type: object description: >- Controls what shift information workers can see, including times, locations, and days-out visibility window. properties: active: type: integer enum: - 0 - 1 description: Whether shift visibility controls are enabled. hide_shift_times: type: integer enum: - 0 - 1 description: Whether to hide shift times from workers. defaultDaysOut: type: number description: Default number of days in advance workers can see shifts. visibility_limited: type: integer enum: - 0 - 1 description: Whether shift visibility is limited to a time window. visibility_limited_customized: type: integer enum: - 0 - 1 description: Whether customized visibility limits are enabled. display_full_location: type: integer enum: - 0 - 1 description: Whether to display full location details to workers. worker_limits: type: object description: Soft and hard caps on worker hours and shifts per period. properties: soft_worker_hour_limit: type: number nullable: true description: Soft cap on worker hours per period. Null if disabled. soft_worker_hour_limit_min_period: type: number description: Minimum period (in days) for soft hour limit calculation. hard_worker_hour_limit: type: number nullable: true description: Hard cap on worker hours per period. Null if disabled. soft_worker_shift_limit: type: number nullable: true description: Soft cap on number of shifts per period. Null if disabled. soft_worker_shift_limit_min_period: type: number description: Minimum period (in days) for soft shift limit calculation. hard_worker_shift_limit: type: number nullable: true description: Hard cap on number of shifts per period. Null if disabled. worker_interaction: type: object description: >- Settings for worker-facing features: bailouts, availability, time off, reviews, blogs, coworker display, and calendar sync. properties: bailouts: type: object description: >- Controls bailout (shift cancellation by worker) rules, limits, and notifications. properties: bailouts_active: type: integer enum: - 0 - 1 description: Whether worker bailouts are enabled. bailouts_customized: type: integer enum: - 0 - 1 description: Whether customized bailout settings are enabled. bailouts_email_max: type: number description: >- Hours before shift start after which a bailout triggers an email notification. bailouts_min: type: number description: Minimum hours before shift start that a bailout is allowed. bailouts_show_hr_email: type: integer enum: - 0 - 1 description: Whether to show HR email in bailout notifications. bailouts_warning_message: type: string nullable: true description: >- Custom warning message shown to workers before they bail out. bailouts_request_bailout_allowed: type: integer enum: - 0 - 1 description: >- Whether workers can request bailouts when bailout is within the allowed window. bailouts_request_bailout_not_allowed: type: integer enum: - 0 - 1 description: >- Whether workers can request bailouts when bailout is outside the allowed window. availability: type: object description: >- Controls worker availability submission, approval requirements, and signup blocking. properties: active: type: integer enum: - 0 - 1 description: Whether the availability feature is enabled. block_autotext: type: integer enum: - 0 - 1 description: Whether to block autotext for unavailable workers. block_signup: type: integer enum: - 0 - 1 description: Whether to block shift signup for unavailable workers. lock_within: type: integer enum: - 0 - 1 description: Whether availability is locked within a certain timeframe. needs_approval: type: integer enum: - 0 - 1 description: Whether availability submissions require admin approval. time_off: type: object description: >- Controls time-off request functionality and approval requirements. properties: active: type: integer enum: - 0 - 1 description: Whether time-off requests are enabled. types_required: type: integer enum: - 0 - 1 description: >- Whether a time-off type must be selected when submitting a request. reviews_and_stars: type: object description: Controls visibility of worker reviews and star ratings. properties: reviews_hidden: type: integer enum: - 0 - 1 description: Whether worker reviews are hidden from workers. stars_hidden: type: integer enum: - 0 - 1 description: Whether star ratings are hidden from workers. stars_hidden_full: type: integer enum: - 0 - 1 description: >- Whether all star ratings are completely hidden (including from admins). blogs: type: object description: Controls the company blog/news feature. properties: active: type: integer enum: - 0 - 1 description: Whether the blog feature is enabled. coworker_display: type: object description: Controls what coworker information is visible on shifts. properties: display_c_emails: type: integer enum: - 0 - 1 description: Whether coworker emails are visible. display_c_numbers: type: integer enum: - 0 - 1 description: Whether coworker phone numbers are visible. display_c_whole_shift: type: integer enum: - 0 - 1 description: Whether the entire shift roster is visible to coworkers. display_c_skillsets: type: integer enum: - 0 - 1 description: Whether coworker skillsets are visible. display_coworkers: type: integer enum: - 0 - 1 description: Whether coworker names are visible on shifts. calendar_sync: type: object description: >- Controls calendar sync (iCal) functionality for workers and admins. properties: worker_calendar_active: type: integer enum: - 0 - 1 description: Whether worker calendar sync is enabled. worker_calendar_reviewer_and_timetracking_calendar: type: integer enum: - 0 - 1 description: >- Whether reviewer and time-tracking manager calendar sync is enabled. admin_calendar_active: type: integer enum: - 0 - 1 description: Whether admin calendar sync is enabled. worker_communication: type: object description: >- Settings for automated messaging: autotext solicitation, web check-in, silence mode, text options, custom messages, invitations, and event updates. properties: autotext: type: object description: >- Controls automated shift solicitation texts, timing, and blackout windows. properties: active: type: integer enum: - 0 - 1 description: Whether autotext solicitation is enabled. blackout_before: type: object nullable: true description: >- Earliest time of day autotext messages can be sent. Null if no blackout. properties: hour: type: integer description: Hour (0-23). minute: type: integer description: Minute (0-59). blackout_after: type: object nullable: true description: >- Latest time of day autotext messages can be sent. Null if no blackout. properties: hour: type: integer description: Hour (0-23). minute: type: integer description: Minute (0-59). hoursBeforeAutoSolicitation: type: number description: Hours before a shift starts to send autotext solicitation. locked_default: type: integer enum: - 0 - 1 description: Whether autotext is locked on by default for new events. no_text_declines: type: integer enum: - 0 - 1 description: Whether to suppress decline notification texts. web_checkin: type: object description: Controls web-based shift check-in and summary notifications. properties: active: type: integer enum: - 0 - 1 description: Whether web check-in is enabled. checkin_text_active: type: integer enum: - 0 - 1 description: Whether text notifications for check-in are enabled. comments: type: integer enum: - 0 - 1 description: Whether check-in comments are enabled. hours_before_event: type: number description: Hours before the event to send check-in notification. hours_before_summary: type: number description: Hours before the event to send summary notification. web_checkin_customized: type: integer enum: - 0 - 1 description: Whether customized check-in settings are enabled. additional_checkins: type: array description: List of additional check-in configurations. items: type: object silence_mode: type: object description: >- Controls global silence mode to suppress all automated communications. properties: active: type: integer enum: - 0 - 1 description: >- Whether silence mode is active (all automated messages suppressed). text_communication: type: object description: >- Controls individual text notification types: shift added/removed, clock-in/out reminders, and timing thresholds. properties: alternate_added: type: integer enum: - 0 - 1 description: Whether to text workers when added as an alternate. alternate_removed: type: integer enum: - 0 - 1 description: Whether to text workers when removed as an alternate. alternate_upgraded: type: integer enum: - 0 - 1 description: Whether to text alternates when upgraded to confirmed. clock_in_forgotten: type: integer enum: - 0 - 1 description: Whether to send forgotten clock-in reminders. clock_in_forgotten_minutes_after_shift_start: type: number description: >- Minutes after shift start to send forgotten clock-in reminder. clock_in_reminder: type: integer enum: - 0 - 1 description: Whether to send clock-in reminders before shift start. clock_in_reminder_minutes_before_shift_start: type: number description: Minutes before shift start to send clock-in reminder. clock_out_forgotten: type: integer enum: - 0 - 1 description: Whether to send forgotten clock-out reminders. clock_out_forgotten_minutes_after_shift_end: type: number description: >- Minutes after shift end to send forgotten clock-out reminder. clock_out_reminder: type: integer enum: - 0 - 1 description: Whether to send clock-out reminders. clock_out_soon_reminder: type: integer enum: - 0 - 1 description: Whether to send upcoming clock-out reminders. clock_out_soon_reminder_minutes_before_shift_end: type: number description: >- Minutes before shift end to send upcoming clock-out reminder. shift_added: type: integer enum: - 0 - 1 description: Whether to text workers when added to a shift. shift_removed: type: integer enum: - 0 - 1 description: Whether to text workers when removed from a shift. custom_messages: type: object description: Customizable message templates. properties: account_status_error: type: string nullable: true description: >- Custom message shown when a worker's account status prevents an action. invite_to_work: type: object description: Controls email and text invite notifications for new workers. properties: email_admin_acceptance: type: integer enum: - 0 - 1 description: Whether to email admins when a worker accepts an invite. email_admin_failure: type: integer enum: - 0 - 1 description: Whether to email admins when an invite delivery fails. email_invite: type: integer enum: - 0 - 1 description: Whether to send invite emails to workers. text_invite: type: integer enum: - 0 - 1 description: Whether to send invite texts to workers. event_updates: type: object description: Controls notifications when events are updated. properties: active: type: integer enum: - 0 - 1 description: Whether event update notifications are enabled. reviewer_update: type: integer enum: - 0 - 1 description: Whether to notify reviewers of event updates. text_active: type: integer enum: - 0 - 1 description: Whether to send text notifications for event updates. text_limited: type: integer enum: - 0 - 1 description: Whether event update texts are limited to a timeframe. text_limited_timeframe: type: number description: Hours before event start within which to send update texts. admin: type: object description: >- Settings for admin tools: daily summaries, verbose emails, list view options, worker profile control, publish system, and bailout reasons. properties: daily_summary: type: object description: Controls automated daily email summaries for admins. properties: active: type: integer enum: - 0 - 1 description: Whether daily summary emails are enabled. active_customized: type: integer enum: - 0 - 1 description: Whether customized daily summary settings are enabled. day_of_the_week: type: integer description: Day of the week for weekly summaries (0=Sunday, 6=Saturday). verbose_emails: type: object description: Controls detail level in admin emails. properties: active: type: integer enum: - 0 - 1 description: Whether verbose emails are enabled. addRoleComments: type: integer enum: - 0 - 1 description: Whether to include role comments in emails. addWholeShiftComments: type: integer enum: - 0 - 1 description: Whether to include whole-shift comments in emails. hidePersonnelEmail: type: integer enum: - 0 - 1 description: Whether to hide personnel email addresses in emails. hidePersonnelPhone: type: integer enum: - 0 - 1 description: Whether to hide personnel phone numbers in emails. list_view_options: type: object description: Controls default list view appearance. properties: high_visibility: type: integer enum: - 0 - 1 description: Whether high-visibility mode is enabled for list view. ampm: type: integer enum: - 0 - 1 description: Whether to use AM/PM time format in list view. default_tab: type: number description: Default tab shown in list view. list_view_verbose: type: object description: Controls which fields appear in verbose list view. properties: active: type: integer enum: - 0 - 1 description: Whether verbose list view is enabled. email: type: integer enum: - 0 - 1 description: Whether to show email in list view. full_location: type: integer enum: - 0 - 1 description: Whether to show full location in list view. phone: type: integer enum: - 0 - 1 description: Whether to show phone number in list view. reviewer: type: integer enum: - 0 - 1 description: Whether to show reviewer in list view. shift_comments: type: integer enum: - 0 - 1 description: Whether to show shift comments in list view. toolkit_comments: type: integer enum: - 0 - 1 description: Whether to show toolkit comments in list view. worker_profile_control: type: object description: >- Controls which worker profile fields are locked from worker editing. properties: address_locked: type: integer enum: - 0 - 1 description: Whether the address field is locked. email_locked: type: integer enum: - 0 - 1 description: Whether the email field is locked. name_locked: type: integer enum: - 0 - 1 description: Whether the name field is locked. number_locked: type: integer enum: - 0 - 1 description: Whether the phone number field is locked. photo_locked: type: integer enum: - 0 - 1 description: Whether the photo field is locked. publish_system: type: object description: Controls the schedule publish workflow and notifications. properties: published: type: integer enum: - 0 - 1 description: Whether the schedule publish system is enabled. text_publish: type: integer enum: - 0 - 1 description: Whether to send text notifications on schedule publish. email_publish: type: integer enum: - 0 - 1 description: Whether to send email notifications on schedule publish. bailout_reason: type: object description: Controls whether workers must provide a reason when bailing out. properties: reason_required: type: integer enum: - 0 - 1 description: Whether a reason is required when bailing out of a shift. time_tracking: type: object description: >- Settings for time tracking: punch system, worker hours display, client sign-off, reimbursements, deductions, and personnel orders. properties: time_tracking: type: object description: >- Core time punch settings: clock-in/out rules, geo-fencing, photo requirements, overtime thresholds, fiscal periods, and worker punch permissions. properties: preapprove_punches: type: integer enum: - 0 - 1 description: Whether time punches are pre-approved automatically. reviewer_punch_in_out: type: integer enum: - 0 - 1 description: Whether reviewers can punch workers in/out. take_picture: type: integer enum: - 0 - 1 description: Whether the photo option is available during clock-in/out. require_picture_with_punch: type: integer enum: - 0 - 1 description: Whether a photo is required with every punch. get_location: type: integer enum: - 0 - 1 description: Whether GPS location is captured during clock-in/out. distance_limited: type: integer enum: - 0 - 1 description: >- Whether clock-in/out is limited by distance from the event location. time_punch_max_distance: type: number description: >- Maximum allowed distance (in feet) from the event location to clock in/out. free_clock_location_required: type: integer enum: - 0 - 1 description: >- Whether location is required for free-clock (unscheduled) punches. start_hard_time_lock: type: integer enum: - 0 - 1 description: Whether early clock-in is restricted. max_early_clock_in: type: number description: Maximum minutes before shift start that clock-in is allowed. end_hard_time_lock: type: integer enum: - 0 - 1 description: Whether late clock-out is restricted. max_late_clock_out: type: number description: Maximum minutes after shift end that clock-out is allowed. fiscal_start_of_week: type: integer description: Fiscal start day of the week (0=Sunday, 6=Saturday). max_continuous_shift_time: type: number description: Maximum hours for a continuous shift before auto clock-out. ampm: type: integer enum: - 0 - 1 description: Whether to use AM/PM format for time tracking display. allow_worker_edit_requests: type: integer enum: - 0 - 1 description: Whether workers can request edits to their time punches. worker_signoff_event_time_punches: type: integer enum: - 0 - 1 description: Whether workers must sign off on their event time punches. worker_signoff_checkbox: type: integer enum: - 0 - 1 description: Whether to show a sign-off checkbox to workers. worker_signoff_checkbox_title: type: string nullable: true description: Title text for the worker sign-off checkbox. worker_signoff_checkbox_description: type: string nullable: true description: Description text for the worker sign-off checkbox. worker_allowed_punches: type: integer enum: - 0 - 1 description: Whether workers are allowed to punch in/out via mobile app. worker_allowed_web_punches: type: integer enum: - 0 - 1 description: Whether workers are allowed to punch in/out via web. daily_overtime_hours: type: number nullable: true description: Daily hours threshold for overtime. Null or 0 if disabled. daily_doubletime_hours: type: number nullable: true description: >- Daily hours threshold for double-time. Null or 0 if disabled. weekly_overtime_hours: type: number nullable: true description: Weekly hours threshold for overtime. Null or 0 if disabled. weekly_doubletime_hours: type: number nullable: true description: >- Weekly hours threshold for double-time. Null or 0 if disabled. fiscal_pay_period_type: type: string description: Pay period type. enum: - Weekly - Every 2 Weeks - Twice a Month - Monthly fiscal_every_2_weeks_start: type: string nullable: true description: >- Start date for bi-weekly pay period calculation (YYYY-MM-DD). show_workers_hours: type: object description: Controls whether workers can see their own tracked hours. properties: active: type: integer enum: - 0 - 1 description: Whether workers can view their hours. show_expected_hours: type: integer enum: - 0 - 1 description: >- Whether to show expected (scheduled) hours alongside actual hours. endless_use_multiple_shifts_assumption: type: integer enum: - 0 - 1 description: >- Whether to use the split shifts hour assumption for open-ended shift hour display. client_sign: type: object description: >- Controls client timesheet signature workflow and email notifications. properties: active: type: integer enum: - 0 - 1 description: Whether client timesheet sign-off is enabled. email_client_timesheets_on_signature: type: integer enum: - 0 - 1 description: >- Whether to email the client a copy of the timesheet on signature. email_reviewer_timesheets_on_signature: type: integer enum: - 0 - 1 description: Whether to email the reviewer on client signature. email_timetracking_manager_timesheets_on_signature: type: integer enum: - 0 - 1 description: >- Whether to email the time-tracking manager on client signature. email_owners_timesheets_on_signature: type: integer enum: - 0 - 1 description: Whether to email company owners on client signature. email_admins_timesheets_on_signature: type: integer enum: - 0 - 1 description: Whether to email admins on client signature. email_timesheets_on_signature_include_individual_punches: type: integer enum: - 0 - 1 description: >- Whether to include individual punch details in signature email. reimbursements: type: object description: Controls reimbursement and mileage tracking. properties: active: type: integer enum: - 0 - 1 description: Whether the reimbursement feature is enabled. allow_worker_viewing: type: integer enum: - 0 - 1 description: Whether workers can view their reimbursements. allow_worker_submission: type: integer enum: - 0 - 1 description: Whether workers can submit reimbursement requests. require_picture_with_mileage: type: integer enum: - 0 - 1 description: >- Whether a photo is required with mileage reimbursements (worker). require_picture_with_reimbursement: type: integer enum: - 0 - 1 description: >- Whether a photo is required with expense reimbursements (worker). require_picture_with_mileage_for_admins: type: integer enum: - 0 - 1 description: >- Whether a photo is required with mileage reimbursements (admin). require_picture_with_reimbursement_for_admins: type: integer enum: - 0 - 1 description: >- Whether a photo is required with expense reimbursements (admin). deductions: type: object description: Controls custom deduction types applied to worker pay. properties: active: type: integer enum: - 0 - 1 description: Whether the deductions feature is enabled. deductions: type: array description: List of configured deduction types. items: type: object personnel_orders: type: object description: >- Controls orderable items (e.g., uniforms, equipment) that workers can request. properties: active: type: integer enum: - 0 - 1 description: Whether personnel orders are enabled. orderables: type: array description: >- List of available orderable items used by the Create Worker Order endpoint. items: type: object securitySchemes: X-API-KEY: name: X-API-KEY type: apiKey in: header ````