---
title: "GET Business"
method: GET
path: "/company/business?access_token=xxxxxxxxxx"
---

# GET Business

`GET /company/business?access_token=xxxxxxxxxx`

## Request

- Base URL: `https://www.humanity.com/api/v2`
- URL: `https://www.humanity.com/api/v2/company/business?access_token=xxxxxxxxxx`
- Auth: API key in query parameter `access_token`

/company/business
Permission level: 5

## Response `200`

200

- object
  - `status` integer
  - `data` object
    - `id` string
    - `franchise` string
    - `status` string
    - `agent` string
    - `hunter` unknown
    - `salessupport` unknown
    - `level` string
    - `price` string
    - `price_back` string
    - `absplit` string
    - `abversion` string
    - `comticket` string
    - `timezone` string
    - `created` string
    - `deleted` string
    - `created_day` string
    - `name` string
    - `domain` string
    - `nemployees` string
    - `billing_employees` string
    - `logo` string
    - `address` string
    - `country` string
    - `state` string
    - `city` string
    - `phone_number` string
    - `fax_number` string
    - `user` string
    - `start_day` string
    - `end_day` string
    - `start_time` string
    - `end_time` string
    - `24hr` string
    - `overtime` string
    - `industry` string
    - `pref_admin_past_edit` string
    - `pref_book_days_off` string
    - `pref_book_days_off_adv` string
    - `pref_book_days_off_max` string
    - `pref_confirm_trade_before` string
    - `pref_confirm_trade_after` string
    - `pref_sms` string
    - `pref_email` string
    - `pref_email_force` integer
    - `pref_pm` string
    - `pref_visible_staff` string
    - `pref_visible_staff_details` string
    - `pref_visible_coworkers` string
    - `pref_trade_shifts` string
    - `pref_same_day_trades` string
    - `pref_coworkers_contacts` string
    - `pref_future_avail` string
    - `pref_weekly_avail` string
    - `pref_approve_availability` string
    - `pref_visible_overview` string
    - `pref_visible_own` string
    - `pref_timeout` string
    - `pref_message_wall_on` string
    - `pref_message_wall_emp` integer
    - `pref_message_wall_comments` string
    - `pref_message_wall_uploads` string
    - `pref_on_now` string
    - `pref_shift_confirm` string
    - `pref_shift_drop` integer
    - `pref_shift_autoconfirm` integer
    - `pref_timeclock` string
    - `pref_tc_terminal_lock` integer
    - `pref_tc_round_to` string
    - `pref_tc_round_to_in` string
    - `pref_tc_round_to_out` string
    - `pref_tc_clock_in_timeframe` string
    - `pref_tc_autoclockout` string
    - `pref_tc_webcam` integer
    - `pref_tc_empl_import` string
    - `pref_tc_empl_addtime` string
    - `pref_tc_require_pos` integer
    - `pref_tc_require_notes` integer
    - `pref_24hr` string
    - `pref_date` string
    - `pref_startday` string
    - `pref_week_adjust` string
    - `pref_currency` string
    - `pref_viewadvance` string
    - `pref_mintimebshifts` string
    - `pref_draft` string
    - `pref_reports` string
    - `pref_edit_profile` integer
    - `pref_login_google` string
    - `pref_login_facebook` integer
    - `pref_login_splogo` integer
    - `pref_login_twitter` string
    - `pref_login_openid` string
    - `pref_scosting` string
    - `pref_training` string
    - `pref_availability_timeframe` string
    - `pref_alt_w_overtime_calc` integer
    - `settings` string
    - `notes` string
    - `created_by` string
    - `new_employee_note` string
    - `personal_welcome_sent` string
    - `ical` string
    - `trial` string
    - `trial_expiration` string
    - `nonprofit` string
    - `casestudy` string
    - `paid_until` string
    - `paid_until_date` unknown
    - `next_payment_date` unknown
    - `groupbilling` string
    - `setup` string
    - `aw_keyword` string
    - `campaign` string
    - `affiliate` string
    - `promo` string
    - `saml_enabled` string
    - `saml_allow_login` string
    - `saml_login_url` string
    - `saml_logout_url` string
    - `saml_certificate` string
    - `saml_fingerprint` string
    - `language` string
    - `daily_overtime` string
    - `pref_min_disregard` integer
    - `max_days_row` string
    - `pref_tc_screenshot` string
    - `group_platform_settings` string
    - `pref_vacation_max_days` string
    - `sort_location` integer
    - `pref_training_to_pdf` integer
    - `pref_pre_time_clock` integer
    - `pref_mandatory_pre_time_clock` integer
    - `pref_user_confirm` string
    - `pref_request_deduct_breaks` integer
    - `timezone_id` string
    - `pref_enable_break_button` string
    - `pref_ping` string
    - `pref_open_overtime` string
    - `pref_show_location_in_shift` string
    - `pref_swap_shifts` string
    - `monthly_overtime` string
    - `health` string
    - `pref_show_midnight` integer
    - `pref_overtime_per_position` integer
    - `pref_approve_overtime` integer
    - `pref_birthday` string
    - `pref_birthday_card` string
    - `pref_birthday_reminder` string
    - `logo_url` string
    - `pref_tc_clock_out_timeframe` string
    - `pref_tc_empl_edittime` string
    - `background_url` unknown
    - `pref_allow_req_acc` integer
    - `security_question` string
    - `security_answer` string
    - `pref_employee_nameformat` string
    - `background` string
    - `pref_tc_gps` string
    - `pref_oncall_manage` integer
    - `pref_referrals` string
    - `custombilling` string
    - `master` string
    - `parent` string
    - `is_parent` string
    - `extra_setup` unknown
    - `saml_cache` unknown
    - `error_trial` string
    - `is_humanity` unknown
    - `pref_dont_show_overlapping_shifts_in_trades` string
    - `pref_tc_timeframe_notify` string
    - `leadspecialist` string
    - `newsletter_receive_type` string
    - `shiftplanning_plus` string
    - `had_wrong_timezone` string
    - `aw_source` string
    - `aw_medium` string
    - `aw_campaign` string
    - `aw_adgroup` string
    - `aw_content` string
    - `aw_term` string
    - `company_id` string
    - `contact_id` string
    - `ambassador` string
    - `ambassador_payed` string
    - `store_id` unknown
    - `intercom_id` string
    - `pref_shift_acknowledgement` string
    - `pref_shift_acknowledgement_notify` string
    - `partner` string
    - `downgrade` string
    - `sign_up_url_without_params` string
    - `sign_up_url_with_params` string
    - `teamtools_id` string
    - `onboarding` string
    - `unique_id` unknown
    - `use_parent_logo` boolean
    - `pref_leave_enabled` string
    - `pref_tc_clock_in_after_timeframe` string
    - `pref_tc_clock_out_after_timeframe` string
    - `pref_vacation_weekdays` string[]
    - `pref_restrict_referrals` integer
    - `pref_staff_visible_eid` integer
    - `pref_employee_files` integer
    - `show_upcoming_birthdays` string
    - `allow_schedulers_to_create_delete_users` string
    - `allow_multiple_filters_in_reports` integer
    - `pref_send_email_via_emailclient` string
    - `pref_only_managers_can_change_staff_password` integer
    - `pref_messaging_module` string
    - `pref_pm_reply` string
    - `autologout` string
    - `password_expire` string
    - `pref_show_overnight_shifts` string
    - `pref_tasks` string
    - `pref_24h_shift` integer
    - `pref_schedule_notes` string
    - `pref_schedule_notes_permissions` string
    - `do_not_initiate_conflicts` integer
    - `pref_show_pending_leaves_on_schedule` integer
    - `pref_see_shift_notes_perm` string
    - `pref_employee_see_vacations` string
    - `pref_sched_show_skill` integer
    - `pref_task_modal` string
    - `pref_disable_shift_trade_between_positions` integer
    - `pref_work_units` string
    - `pref_work_units_employees` string
    - `pref_schedulers_workunit_autoapproved` integer
    - `pref_employees_workunit_autoapproved` integer
    - `pref_wu_emp_can_see_report` string
    - `pref_tc_webcam_mobile` integer
    - `pref_webcam_resolution` string
    - `pref_tc_unavailable_gps` integer
    - `pref_tc_address` integer
    - `pref_restrict_empl_clockinout` integer
    - `pref_tc_require_remote_site` integer
    - `pref_tc_tips` integer
    - `pref_timeclock_show_scheduled_details` string
    - `pref_timeclock_show_breaks_mts` integer
    - `pref_restrict_overlapping_timesheets` integer
    - `pref_tc_round_to_in_direction` string
    - `pref_tc_round_to_out_direction` string
    - `pref_tc_prevent_empl_edittime_approved` integer
    - `pref_tc_prevent_empl_addclock_x_days` string
    - `show_timesheet_notes` integer
    - `pref_mandatory_notes` integer
    - `pref_emp_can_edit_tc_without_providing_reason` integer
    - `pref_admin_clockin_reminder_schedulers` string
    - `pref_admin_clockin_reminder_managers` string
    - `pref_admin_clockout_reminder_schedulers` string
    - `pref_admin_clockout_reminder_managers` string
    - `pref_sched_can_approve_availability` string
    - `pref_vacation_show_deleted` integer
    - `pref_vac_req_only_schedulers` integer
    - `pref_sched_can_approve_past_vacations` integer
    - `pref_employee_delete_vacations` string
    - `overtime_module` string
    - `pref_cot_order15` integer
    - `pref_payroll_reports` integer
    - `rate_of_pay` string
    - `pref_allow_scheduler_to_see_wages` integer
    - `pref_allow_scheduler_to_see_budget` integer
    - `pref_allow_scheduler_to_edit_budget` integer
    - `allow_schedulers_payroll_report` integer
    - `num_of_decimals` string
    - `export_provider` string
    - `company_code` string
    - `batch_id` string
    - `fixed_batch_id` string
    - `regular_hour_code` string
    - `special_hour_code` string
    - `overtime_hour_code` string
    - `export_payrate` string
    - `export_amount` string
    - `company_name` string
    - `company_created_time` string
    - `qb_position_to_item` integer
    - `payroll` object
      - `company_code` string
      - `batch_id` string
      - `fixed_batch_id` integer
      - `regular_hour_code` string
      - `special_hour_code` string
      - `overtime_hour_code` string
      - `company_name` string
      - `company_created_time` string
      - `export_provider` string
      - `rate_of_pay` string
      - `export_payrate` string
      - `qb_position_to_item` unknown
      - `export_amount` string
      - `tax_frequency` string
    - `groupforce` object
      - `overtime_module` integer
      - `daily_overtime` integer
      - `overtime` integer
      - `pref_request_deduct_breaks` integer
      - `pref_payroll_reports` integer
    - `pref_include_ghost_shifts` string
    - `geofencing_distance` unknown
    - `tax_frequency` string
  - `token` string
  - `error` unknown

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `ffb87b44c733`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/humanity-com/apis/humanity/changes/company/business%3Faccess_token=xxxxxxxxxx/get.md)

---

[API](https://skmtc.dev/humanity-com/apis/humanity.md) - [All operations](https://skmtc.dev/humanity-com/apis/humanity/llms.txt) - [OpenAPI document](https://skmtc.dev/humanity-com/apis/humanity/revisions/ffb87b44c733?raw)
