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": {},
    "split_shifts": {
      "endless_ern_hour_assumption": 123
    },
    "shift_equalizer": {},
    "shift_visibility": {
      "defaultDaysOut": 123
    },
    "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_email_max": 123,
      "bailouts_min": 123,
      "bailouts_warning_message": "<string>"
    },
    "availability": {},
    "time_off": {},
    "reviews_and_stars": {},
    "blogs": {},
    "coworker_display": {},
    "calendar_sync": {}
  },
  "worker_communication": {
    "autotext": {
      "blackout_before": {
        "hour": 123,
        "minute": 123
      },
      "blackout_after": {
        "hour": 123,
        "minute": 123
      },
      "hoursBeforeAutoSolicitation": 123
    },
    "web_checkin": {
      "hours_before_event": 123,
      "hours_before_summary": 123,
      "additional_checkins": [
        {}
      ]
    },
    "silence_mode": {},
    "text_communication": {
      "clock_in_forgotten_minutes_after_shift_start": 123,
      "clock_in_reminder_minutes_before_shift_start": 123,
      "clock_out_forgotten_minutes_after_shift_end": 123,
      "clock_out_soon_reminder_minutes_before_shift_end": 123
    },
    "custom_messages": {
      "account_status_error": "<string>"
    },
    "invite_to_work": {},
    "event_updates": {
      "text_limited_timeframe": 123
    }
  },
  "admin": {
    "daily_summary": {
      "day_of_the_week": 123
    },
    "verbose_emails": {},
    "list_view_options": {
      "default_tab": 123
    },
    "list_view_verbose": {},
    "worker_profile_control": {},
    "publish_system": {},
    "bailout_reason": {}
  },
  "time_tracking": {
    "time_tracking": {
      "time_punch_max_distance": 123,
      "max_early_clock_in": 123,
      "max_late_clock_out": 123,
      "fiscal_start_of_week": 123,
      "max_continuous_shift_time": 123,
      "worker_signoff_checkbox_title": "<string>",
      "worker_signoff_checkbox_description": "<string>",
      "daily_overtime_hours": 123,
      "daily_doubletime_hours": 123,
      "weekly_overtime_hours": 123,
      "weekly_doubletime_hours": 123,
      "fiscal_every_2_weeks_start": "<string>"
    },
    "show_workers_hours": {},
    "client_sign": {},
    "reimbursements": {},
    "deductions": {
      "deductions": [
        {}
      ]
    },
    "personnel_orders": {
      "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.