Api doc


SDK's


Api Modules

admin.business

Retrives business details



Supported Methods:

GET
Params
  • token (Required): valid token


Documentation

GET
Retrieves a business details.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"admin.business",
  3. "method":"GET",
  4. "request":{
  5.  
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"553",
  5. "franchise":"553",
  6. "status":"1",
  7. "agent":"43232423",
  8. "hunter":null,
  9. "level":"1",
  10. "price":"1",
  11. "timezone":"-05:00,1",
  12. "created":"1265595316",
  13. "deleted":"0",
  14. "created_day":"300",
  15. "name":"Test",
  16. "domain":"domain",
  17. "nemployees":"74",
  18. "logo":"0",
  19. "address":"Address 15",
  20. "country":"227",
  21. "state":"AZ",
  22. "phone_number":"888-432-1233",
  23. "fax_number":"281-321-1231",
  24. "user":"12313",
  25. "start_day":"1",
  26. "end_day":"7",
  27. "start_time":"0",
  28. "end_time":"0",
  29. "24hr":"0",
  30. "overtime":"40",
  31. "industry":"6",
  32. "pref_admin_past_edit":"0",
  33. "pref_book_days_off":"1",
  34. "pref_book_days_off_adv":"30",
  35. "pref_book_days_off_max":"10",
  36. "pref_confirm_trade_before":"1",
  37. "pref_confirm_trade_after":"1",
  38. "pref_sms":"1",
  39. "pref_email":"1",
  40. "pref_email_force":"0",
  41. "pref_pm":"1",
  42. "pref_visible_staff":"1",
  43. "pref_visible_staff_details":"1",
  44. "pref_visible_coworkers":"1",
  45. "pref_trade_shifts":"1",
  46. "pref_coworkers_contacts":"0",
  47. "pref_future_avail":"1",
  48. "pref_weekly_avail":"1",
  49. "pref_visible_overview":"0",
  50. "pref_visible_own":"1",
  51. "pref_timeout":"0",
  52. "pref_message_wall_on":"1",
  53. "pref_message_wall_emp":"0",
  54. "pref_message_wall_comments":"1",
  55. "pref_message_wall_uploads":"0",
  56. "pref_on_now":"0",
  57. "pref_shift_confirm":"1",
  58. "pref_shift_drop":"0",
  59. "pref_shift_autoconfirm":"0",
  60. "pref_timeclock":"1",
  61. "pref_tc_terminal_lock":"0",
  62. "pref_tc_round_to":"-1",
  63. "pref_tc_round_to_in":"-1",
  64. "pref_tc_round_to_out":"-1",
  65. "pref_tc_clock_in_timeframe":"-1",
  66. "pref_tc_autoclockout":"0",
  67. "pref_tc_webcam":"0",
  68. "pref_tc_empl_import":"0",
  69. "pref_tc_empl_addtime":"1",
  70. "pref_tc_require_pos":"0",
  71. "pref_tc_require_notes":"0",
  72. "pref_24hr":"0",
  73. "pref_date":"M j, Y",
  74. "pref_startday":"1",
  75. "pref_currency":"1",
  76. "pref_viewadvance":"-1",
  77. "pref_mintimebshifts":"0",
  78. "pref_draft":"1",
  79. "pref_reports":"1",
  80. "pref_edit_profile":"1",
  81. "pref_login_google":"1",
  82. "pref_login_facebook":"1",
  83. "pref_login_splogo":"1",
  84. "pref_login_twitter":"1",
  85. "pref_scosting":"3",
  86. "pref_training":"1",
  87. "settings":"{\"payroll\":{\"company_code\":\"5\",\"batch_id\":\"9\",
  88. \"fixed_batch_id\":1,\"regular_hour_code\":\"R\",\"special_hour_code\":\"08
  89. \",\"overtime_hour_code\":\"02\",\"company_name\":\"Test\",\"company_created_time
  90. \":\"1329996350\",\"export_provider\":\"5\"},\"login\":{\"ssl\":null}}",
  91. "notes":"",
  92. "created_by":"0",
  93. "new_employee_note":"",
  94. "personal_welcome_sent":"1",
  95. "ical":"asdmi2is929sda9dsa0dsad9sad0as0das0",
  96. "trial":"90",
  97. "nonprofit":"0",
  98. "paid_until":"0",
  99. "groupbilling":"1",
  100. "setup":"0",
  101. "aw_keyword":"",
  102. "affiliate":"",
  103. "saml_enabled":"1",
  104. "saml_allow_login":"0",
  105. "saml_login_url":"https:\/\/app.onelogin.com\/saml\/signon\/35439",
  106. "saml_logout_url":"http:\/\/www.humanity.com?saml_logout=true",
  107. "saml_certificate":"-----CERTIFICAT-----",
  108. "saml_fingerprint":"xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx",
  109. "timezone_id":"80",
  110. "language":"en_US",
  111. "daily_overtime":"9",
  112. "pref_min_disregard":"0",
  113. "max_days_row":"4",
  114. "pref_same_day_trades":"1",
  115. "pref_tc_screenshot":"0",
  116. "group_platform_settings":"{\"Scheduler\":\"4\",\"Supervisor\":\"3
  117. \",\"color_customization\":\"1\",\"color_nav\":\"#0A0A0A\",\"color_nav_text\":\"#ffffff
  118. \",\"color_nav_left\":\"#F7F7F7\",\"color_nav_left_text\":\"#3F3F3F\",\"color_nav_left_act
  119. \":\"#D6D6D9\",\"color_nav_left_act_text\":\"#3F3F3F\",\"color_links\":\"#99131E
  120. \",\"color_headings\":\"#D12F19\",\"master_logo\":\"1\",\"disallow_logo\":\"1\",\"Manager
  121. \":\"2\",\"Employee\":\"5\"}"
  122. },
  123. "token":"xxxxxxx"
  124. }