Api doc


SDK's


Api Modules

staff.me



Supported Methods:

GET
Params
  • token (Required): valid token


Documentation

Using the staff.me module you will receive a response that provides you with detail information about an employee including his/her role, language settings, positions and much more. Anyone within the store can use this module as it requires level 7(Schedule Viewer role)

Parameters

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

You can read here how to get your token.

Example request:

  1. {
  2. "method":"GET",
  3. "module":"staff.me",
  4. "token":"xxxx"
  5. }

Example response

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"2829173",
  5. "username":"rudez",
  6. "tusername":"",
  7. "reset_code":null,
  8. "reset_code_expire":null,
  9. "email":"example.email@example.com",
  10. "title":null,
  11. "realname":"Mitch",
  12. "url":null,
  13. "jabber":null,
  14. "icq":null,
  15. "msn":null,
  16. "aim":null,
  17. "yahoo":null,
  18. "location":"0",
  19. "signature":null,
  20. "disp_topics":null,
  21. "disp_posts":null,
  22. "email_setting":"1",
  23. "notify_with_post":"0",
  24. "auto_notify":"0",
  25. "show_smilies":"1",
  26. "show_img":"1",
  27. "show_img_sig":"1",
  28. "show_avatars":"1",
  29. "show_sig":"1",
  30. "access_keys":"0",
  31. "timezone":"314",
  32. "dst":"0",
  33. "time_format":"0",
  34. "date_format":"0",
  35. "language":null,
  36. "style":"ShiftPlanning",
  37. "num_posts":"0",
  38. "last_post":null,
  39. "last_search":"1491425942",
  40. "last_email_sent":"1477998871",
  41. "registered":"1473084421",
  42. "registration_ip":"xxx.xxx.xxx.xxx",
  43. "last_visit":"1491912931",
  44. "last_active":"1491921186",
  45. "admin_note":null,
  46. "activate_string":null,
  47. "activate_key":null,
  48. "pun_bbcode_enabled":"1",
  49. "pun_bbcode_use_buttons":"1",
  50. "pun_pm_new_messages":null,
  51. "pun_pm_long_subject":"1",
  52. "newsletter":"1",
  53. "email_confirmed":"1",
  54. "eid":"",
  55. "status":"1",
  56. "deleted":"0",
  57. "deleted_by":"0",
  58. "legal_agree":"1",
  59. "referral":"0",
  60. "wage":"",
  61. "name":"Mitch",
  62. "firstname":"Mitch",
  63. "lastname":"",
  64. "nick_name":"",
  65. "birth_day":"0",
  66. "birth_month":"0",
  67. "smsgateway":"-1",
  68. "cell_phone":"",
  69. "cellphone_confirmed":"0",
  70. "last_sms_sent":"0",
  71. "home_phone":"",
  72. "avatar":{
  73. "small":"https:\/\/s3.amazonaws.com\/uf.shiftplanning.com\/avatars\/sm_2829173-58d414ca8180a.jpg",
  74. "medium":"https:\/\/s3.amazonaws.com\/uf.shiftplanning.com\/avatars\/profile_2829173-58d414ca8180a.jpg",
  75. "large":"https:\/\/s3.amazonaws.com\/uf.shiftplanning.com\/avatars\/2829173-58d414ca8180a.jpg"
  76. },
  77. "address":"",
  78. "city":"",
  79. "state":"",
  80. "zip":"",
  81. "notes":"",
  82. "p_email":"1",
  83. "p_phone":"1",
  84. "notify_sms":"-1",
  85. "notify_email":"1",
  86. "e_new_pm":"0",
  87. "ical":"https:\/\/www.humanity.com\/ical\/175a320ca46cddca310c9c21e0369a80.ics",
  88. "24hr":"0",
  89. "startday":"1",
  90. "pref_caltime":"10",
  91. "pref_shift_autoconfirm":"-1",
  92. "undertime":"9",
  93. "overtime":"40",
  94. "recommend":"0",
  95. "recommendation":"",
  96. "tut_v2_sched":"0",
  97. "daily_overtime":"0",
  98. "max_days_row":"-1",
  99. "pref_vacation_max_days":"-1",
  100. "timezone_id":null,
  101. "monthly_undertime":"0",
  102. "monthly_overtime":"-1",
  103. "pref_mtimebshifts":"0",
  104. "avatar_url":{
  105. "large":"avatars\/2829173-58d414ca8180a.jpg",
  106. "small":"avatars\/sm_2829173-58d414ca8180a.jpg",
  107. "bigger":"avatars\/la_2829173-58d414ca8180a.jpg",
  108. "full":"avatars\/full_2829173-58d414ca8180a.jpg",
  109. "profile":"avatars\/profile_2829173-58d414ca8180a.jpg",
  110. "forum":"avatars\/forum_2829173-58d414ca8180a.jpg"
  111. },
  112. "deactivated":"0",
  113. "work_start_date":"2016-09-05 19:07:00",
  114. "screen_logger":"0",
  115. "sc_freq":"-2",
  116. "newsletter_receiver":"0",
  117. "job_title":"",
  118. "middle_name":"",
  119. "gender":"",
  120. "pref_sp_skin":"1",
  121. "inline_wizard_completion":"4_notifications_time",
  122. "teamtools_id":"1",
  123. "group":"2",
  124. "timezone_name":"Europe\/Belgrade",
  125. "timezone_info":{
  126. "timezone_id":"314",
  127. "name":"Europe\/Belgrade",
  128. "name_formatted":"(UTC +01:00) Europe\/Belgrade",
  129. "offset":"+2:00",
  130. "seconds":7200,
  131. "hours":2,
  132. "default":"0",
  133. "minutes":0
  134. },
  135. "group_name":"Manager",
  136. "status_name":"Activated",
  137. "schedules":{
  138. "1411080":"Unimaginative position1",
  139. "1411081":"Unimaginative position2",
  140. "1411082":"Unimaginative position3",
  141. },
  142. "skills":[
  143.  
  144. ],
  145. "custom":[
  146.  
  147. ],
  148. "settings":{
  149. "widgets_layout":[
  150. [
  151. "timeclock",
  152. "leaves",
  153. "training",
  154. "files",
  155. "onnow",
  156. "upcomingshifts",
  157. "notices"
  158. ],
  159. [
  160. "lateforwork",
  161. "birthdays"
  162. ],
  163. [
  164. "messagewall"
  165. ]
  166. ],
  167. "schedule_side_panel_visibility":1
  168. },
  169. "store":"258469"
  170. },
  171. "token":"xxxx"
  172. }