Humanity HVII Public API

Humanity Public API Developer Hub

Welcome to the Humanity Public API Developer Hub. You'll find comprehensive guides and documentation to help you start working with Humanity Public API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started
Suggest Edits

GET Me

/me
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/me
https://www.humanity.com/api/v2/me?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": "2736727",
    "username": "publicapitest",
    "tusername": "",
    "email": "milos.tomic+pubapitest@shiftplanning.com",
    "title": null,
    "realname": "Brian Lane",
    "url": null,
    "jabber": null,
    "icq": null,
    "msn": null,
    "aim": null,
    "yahoo": null,
    "location": "0",
    "signature": null,
    "disp_topics": null,
    "disp_posts": null,
    "email_setting": "1",
    "notify_with_post": "0",
    "auto_notify": "0",
    "show_smilies": "1",
    "show_img": "1",
    "show_img_sig": "1",
    "show_avatars": "1",
    "show_sig": "1",
    "access_keys": "0",
    "timezone": "314",
    "dst": "0",
    "time_format": "0",
    "date_format": "0",
    "language": null,
    "style": "ShiftPlanning",
    "num_posts": "0",
    "last_post": null,
    "last_search": null,
    "last_email_sent": null,
    "registered": "1469803042",
    "registration_ip": "82.117.214.54",
    "last_visit": "1470130498",
    "last_active": "1470132148",
    "admin_note": null,
    "activate_string": null,
    "activate_key": null,
    "pun_bbcode_enabled": "1",
    "pun_bbcode_use_buttons": "1",
    "pun_pm_new_messages": null,
    "pun_pm_long_subject": "1",
    "newsletter": "1",
    "email_confirmed": "0",
    "eid": "",
    "status": "1",
    "deleted": "0",
    "deleted_by": "0",
    "legal_agree": "1",
    "referral": "0",
    "wage": "",
    "name": "Brian Lane",
    "firstname": "Brian",
    "lastname": "Lane",
    "nick_name": "",
    "birth_day": "0",
    "birth_month": "0",
    "smsgateway": null,
    "cell_phone": "",
    "cellphone_confirmed": "0",
    "last_sms_sent": "0",
    "home_phone": "",
    "avatar": {
      "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/2dd54e17ff0a64f557f184dff90af9cca04ba05b/images/no_avatar.png",
      "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/2dd54e17ff0a64f557f184dff90af9cca04ba05b/images/no_avatar.png",
      "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/2dd54e17ff0a64f557f184dff90af9cca04ba05b/images/no_avatar.png"
    },
    "address": "",
    "city": "",
    "state": "",
    "zip": "",
    "notes": "",
    "p_email": "1",
    "p_phone": "1",
    "notify_sms": "-1",
    "notify_email": "1",
    "e_new_pm": "0",
    "ical": "https://www.humanity.shiftplanning.com/ical/869e0e6a380543a59443f360d49fa0fb.ics",
    "24hr": "0",
    "startday": "1",
    "pref_caltime": "10",
    "pref_shift_autoconfirm": "-1",
    "undertime": "0",
    "overtime": "-1",
    "recommend": "0",
    "recommendation": "",
    "tut_v2_sched": "0",
    "daily_overtime": "0",
    "max_days_row": "-1",
    "pref_vacation_max_days": "-1",
    "timezone_id": null,
    "monthly_undertime": "0",
    "monthly_overtime": "-1",
    "pref_mtimebshifts": "0",
    "avatar_url": null,
    "deactivated": "0",
    "work_start_date": "2016-07-29 16:37:00",
    "screen_logger": "0",
    "sc_freq": "-2",
    "newsletter_receiver": "0",
    "job_title": "",
    "middle_name": "",
    "gender": "",
    "pref_sp_skin": "1",
    "inline_wizard_completion": "",
    "group": "2",
    "timezone_name": "Europe/Belgrade",
    "timezone_info": {
      "timezone_id": "314",
      "name": "Europe/Belgrade",
      "name_formatted": "(UTC +01:00) Europe/Belgrade",
      "offset": "+2:00",
      "seconds": 7200,
      "hours": 2,
      "default": "0",
      "minutes": 0
    },
    "group_name": "Manager",
    "status_name": "Activated",
    "schedules": {
      "1321634": "Manager"
    },
    "skills": {
      "96398": "sales",
      "96403": "managing",
      "96404": "leadership"
    },
    "store": "251300"
  },
  "token": "xxxxxxxxxxx"
}
 

Returns information about requester.

Suggest Edits

GET Companies

/companies
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/companies
https://www.humanity.com/api/v2/companies?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": [
    {
      "id": "251300",
      "name": "Public API Test",
      "parent": null,
      "is_parent": "0"
    }
  ],
  "token": "xxxxxxx"
}

Query Params

detailed
int32

enum[0,1] -> 0: Not detailed; 1: Detailed

detailed_staff
int32

enum[0,1] -> 0: Not detailed; 1: Detailed

 

Group Account Management - Returns a list of all accounts in the Group

Suggest Edits

GET Company

/companies/:id
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/companies/id
https://www.humanity.com/api/v2/companies/251300?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": "251300",
    "name": "Dream Coffee Shop 1",
    "domain": "publicapitest",
    "created": "1469803042",
    "language": "en_US",
    "master": "0",
    "parent": null,
    "is_parent": "0",
    "franchise": "0",
    "settings": {
      "admin_past_edit": "0",
      "book_days_off": "1",
      "book_days_off_adv": "-1",
      "book_days_off_max": "0",
      "confirm_trade_before": "1",
      "confirm_trade_after": "0",
      "sms": "1",
      "email": "1",
      "pm": "1",
      "visible_staff": "1",
      "visible_staff_details": "1",
      "visible_coworkers": "1",
      "trade_shifts": "1",
      "coworkers_contacts": "1",
      "future_avail": "1",
      "weekly_avail": "1",
      "visible_overview": "0",
      "visible_own": "1",
      "timeout": "1800",
      "message_wall_on": "1",
      "message_wall_emp": "0",
      "message_wall_comments": "1",
      "message_wall_uploads": "1",
      "on_now": "1",
      "shift_confirm": "0",
      "shift_drop": "0",
      "shift_autoconfirm": "0",
      "timeclock": "1",
      "tc_terminal_lock": "0",
      "tc_round_to": "15",
      "tc_round_to_in": "0",
      "tc_round_to_out": "0",
      "tc_clock_in_timeframe": "-1",
      "tc_clock_out_timeframe": "-1",
      "tc_autoclockout": "0.0",
      "tc_webcam": "0",
      "tc_empl_import": "1",
      "tc_empl_addtime": "1",
      "tc_empl_edittime": "0",
      "24hr": "0",
      "draft": "1",
      "date": "M j, Y",
      "startday": "1",
      "currency": "1",
      "viewadvance": "0",
      "login_splogo": "1",
      "scosting": "3",
      "start_day": "1",
      "end_day": "7",
      "start_time": "33",
      "end_time": "85",
      "overtime": "40",
      "timezone": "-05:00,0"
    },
    "admin": {
      "id": "2736727",
      "name": "Brian Lane",
      "email": "milos.tomic+pubapitest@shiftplanning.com"
    },
    "staff": [
      {
        "id": "2736727",
        "name": "Brian Lane"
      },
      {
        "id": "2744092",
        "name": "Derrick Arnold"
      },
      {
        "id": "2744093",
        "name": "Frederick Braxton"
      },
      {
        "id": "2744094",
        "name": "Josephine P. Watson"
      },
      {
        "id": "2744095",
        "name": "Kian Simonette"
      },
      {
        "id": "2744096",
        "name": "Michael Rivas"
      },
      {
        "id": "2744097",
        "name": "Sheri Downer"
      },
      {
        "id": "2744098",
        "name": "Timothy Edison"
      }
    ],
    "locations": {
      "542311": "Dream Coffee Shop 2"
    },
    "positions": [
      {
        "id": "1321636",
        "name": "Desk Service",
        "l_name": null,
        "l_id": null
      },
      {
        "id": "1321634",
        "name": "Manager",
        "l_name": null,
        "l_id": null
      },
      {
        "id": "1321635",
        "name": "Waiter",
        "l_name": null,
        "l_id": null
      },
      {
        "id": "1324358",
        "name": "Barista",
        "l_name": "Dream Coffee Shop 2",
        "l_id": "542311"
      },
      {
        "id": "1324361",
        "name": "Customer service",
        "l_name": "Dream Coffee Shop 2",
        "l_id": "542311"
      },
      {
        "id": "1324363",
        "name": "Shop Manager",
        "l_name": "Dream Coffee Shop 2",
        "l_id": "542311"
      }
    ]
  },
  "token": "xxxxxxx"
}

Path Params

id
int32
required
 

Returns information about company.

Suggest Edits

GET Company Settings

/companies/:id/settings
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/company/settings
https://www.humanity.com/api/v2/company/settings?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "admin_past_edit": "0",
    "edit_profile": "1",
    "reports": "1",
    "book_days_off": "1",
    "book_days_off_adv": "-1",
    "book_days_off_max": "30",
    "confirm_trade_before": "0",
    "confirm_trade_after": "1",
    "sms": "1",
    "email": "1",
    "pm": "1",
    "visible_staff": "1",
    "visible_staff_details": "1",
    "visible_coworkers": "0",
    "trade_shifts": "1",
    "coworkers_contacts": "0",
    "future_avail": "1",
    "weekly_avail": "1",
    "visible_overview": "1",
    "visible_own": "1",
    "timeout": "0",
    "message_wall_on": "1",
    "message_wall_emp": "1",
    "message_wall_comments": "1",
    "message_wall_uploads": "0",
    "on_now": "1",
    "shift_confirm": "1",
    "shift_drop": "1",
    "shift_autoconfirm": "0",
    "timeclock": "1",
    "tc_terminal_lock": "0",
    "tc_round_to": "-1",
    "tc_round_to_in": "-1",
    "tc_round_to_out": "-1",
    "tc_clock_in_timeframe": "-1",
    "tc_autoclockout": "18.0",
    "tc_webcam": "0",
    "tc_empl_import": "1",
    "tc_empl_addtime": "0",
    "24hr": "1",
    "draft": "1",
    "date": "M j, Y",
    "startday": "2",
    "currency": "1",
    "viewadvance": "-1",
    "login_splogo": "0",
    "scosting": "1",
    "start_day": "1",
    "end_day": "7",
    "start_time": "33",
    "end_time": "85",
    "overtime": "45",
    "timezone": "-05:00,0",
    "availability_timeframe": "0",
    "alt_w_overtime_calc": "0",
    "birthday": null,
    "birthday_card": "1",
    "oncall_manage": "1",
    "allow_req_acc": "0",
    "security_question": "who is our mascot",
    "security_answer": "wizard",
    "messaging_system": "1",
    "tc_empl_edittime": "0"
  },
  "error": null
}
 

Returns company settings

Suggest Edits

PUT Company Settings

/companies/:id/settings
Permission level: 2

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/company/settings
https://www.humanity.com/api/v2/company/settings?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "admin_past_edit": "0",
    "edit_profile": "1",
    "reports": "1",
    "book_days_off": "1",
    "book_days_off_adv": "-1",
    "book_days_off_max": "30",
    "confirm_trade_before": "0",
    "confirm_trade_after": "1",
    "sms": "1",
    "email": "1",
    "pm": "1",
    "visible_staff": "1",
    "visible_staff_details": "1",
    "visible_coworkers": "0",
    "trade_shifts": "1",
    "coworkers_contacts": "0",
    "future_avail": "1",
    "weekly_avail": "1",
    "visible_overview": "1",
    "visible_own": "1",
    "timeout": "0",
    "message_wall_on": "1",
    "message_wall_emp": "1",
    "message_wall_comments": "1",
    "message_wall_uploads": "0",
    "on_now": "1",
    "shift_confirm": "1",
    "shift_drop": "1",
    "shift_autoconfirm": "0",
    "timeclock": "1",
    "tc_terminal_lock": "0",
    "tc_round_to": "-1",
    "tc_round_to_in": "-1",
    "tc_round_to_out": "-1",
    "tc_clock_in_timeframe": "-1",
    "tc_autoclockout": "18.0",
    "tc_webcam": "0",
    "tc_empl_import": "1",
    "tc_empl_addtime": "0",
    "24hr": "1",
    "draft": "1",
    "date": "M j, Y",
    "startday": "2",
    "currency": "1",
    "viewadvance": "-1",
    "login_splogo": "0",
    "scosting": "1",
    "start_day": "1",
    "end_day": "7",
    "start_time": "33",
    "end_time": "85",
    "overtime": "45",
    "timezone": "-05:00,0",
    "availability_timeframe": "0",
    "alt_w_overtime_calc": "0",
    "birthday": null,
    "birthday_card": "1",
    "oncall_manage": "1",
    "allow_req_acc": "0",
    "security_question": "who is our mascot",
    "security_answer": "wizard",
    "settings": "{\"emailsig_redirect_url\":\"\",\"pref_vacation_weekdays\":\"[\"0\",\"6\"]\",\"pref_tc_clock_in_after_timeframe\":\"-1\",\"pref_tc_clock_out_after_timeframe\":\"-1\",\"country\":\"227\",\"timezone_id\":\"314\",\"language\":\"en_US\",\"pref_date\":\"M j, Y\",\"pref_24hr\":\"1\",\"pref_week_adjust\":\"0\",\"pref_restrict_referrals\":0,\"pref_email\":\"1\",\"pref_sms\":\"1\",\"pref_email_force\":0,\"pref_birthday\":0,\"pref_birthday_card\":\"1\",\"sort_location\":0,\"pref_show_location_in_shift\":\"1\",\"pref_show_overnight_shifts\":\"1\",\"pref_startday\":\"2\",\"pref_draft\":\"1\",\"pref_shift_confirm\":\"1\",\"pref_viewadvance\":\"-1\",\"pref_scosting\":\"1\",\"pref_trade_shifts\":\"1\",\"pref_swap_shifts\":\"1\",\"pref_same_day_trades\":0,\"pref_dont_show_overlapping_shifts_in_trades\":0,\"pref_disable_shift_trade_between_positions\":0,\"pref_confirm_trade_before\":0,\"pref_confirm_trade_after\":\"1\",\"pref_visible_overview\":\"1\",\"pref_visible_own\":\"1\",\"pref_visible_coworkers\":0,\"pref_shift_drop\":\"1\",\"pref_shift_autoconfirm\":0,\"pref_open_overtime\":0,\"pref_mintimebshifts\":\"24\",\"pref_min_disregard\":0,\"max_days_row\":\"30\",\"pref_show_midnight\":\"1\",\"pref_oncall_manage\":\"1\",\"pref_employee_see_vacations\":\"1\",\"pref_sched_show_skill\":\"1\",\"pref_work_units\":0,\"pref_work_units_employees\":0,\"pref_schedulers_workunit_autoapproved\":0,\"pref_wu_emp_can_see_report\":0,\"pref_tasks\":\"1\",\"pref_24h_shift\":0,\"pref_schedule_notes\":\"1\",\"pref_schedule_notes_permissions\":\"7\",\"do_not_initiate_conflicts\":0,\"pref_shift_acknowledgement\":0,\"pref_shift_acknowledgement_notify\":\"1\",\"pref_show_pending_leaves_on_schedule\":\"1\",\"pref_see_shift_notes_perm\":\"7\",\"pref_task_modal\":\"0\",\"pref_employee_nameformat\":\"F L\",\"pref_training\":\"1\",\"pref_training_to_pdf\":0,\"pref_reports\":\"1\",\"pref_payroll_reports\":\"1\",\"pref_edit_profile\":\"1\",\"pref_visible_staff\":\"1\",\"pref_visible_staff_details\":\"1\",\"pref_staff_visible_eid\":0,\"pref_on_now\":\"1\",\"pref_allow_req_acc\":0,\"security_question\":\"who is our mascot\",\"security_answer\":\"wizard\",\"pref_employee_files\":\"1\",\"show_upcoming_birthdays\":\"1\",\"allow_schedulers_to_create_delete_users\":\"1\",\"pref_send_email_via_emailclient\":0,\"pref_timeclock\":\"1\",\"pref_tc_webcam\":0,\"pref_tc_webcam_mobile\":0,\"pref_webcam_resolution\":\"320\",\"pref_tc_gps\":\"1\",\"pref_tc_unavailable_gps\":\"1\",\"pref_tc_address\":\"1\",\"pref_pre_time_clock\":0,\"pref_mandatory_pre_time_clock\":0,\"pref_tc_empl_import\":\"1\",\"pref_tc_empl_addtime\":0,\"pref_tc_empl_edittime\":0,\"pref_tc_prevent_empl_edittime_approved\":0,\"pref_tc_prevent_empl_addclock_x_days\":\"0\",\"pref_tc_terminal_lock\":0,\"pref_tc_require_pos\":\"1\",\"pref_tc_require_remote_site\":0,\"pref_tc_require_notes\":0,\"pref_tc_round_to\":\"-1\",\"pref_tc_round_to_in\":\"-1\",\"pref_tc_round_to_in_direction\":\"1\",\"pref_tc_round_to_out\":\"-1\",\"pref_tc_round_to_out_direction\":\"1\",\"pref_tc_clock_in_timeframe\":\"-1\",\"pref_tc_clock_out_timeframe\":\"-1\",\"pref_enable_break_button\":\"1\",\"pref_admin_clockin_reminder_schedulers\":\"[\"15\"]\",\"pref_admin_clockin_reminder_managers\":\"[\"15\"]\",\"pref_admin_clockout_reminder_schedulers\":\"[]\",\"pref_admin_clockout_reminder_managers\":\"[]\",\"pref_tc_timeframe_notify\":null,\"pref_tc_autoclockout\":\"18\",\"pref_restrict_overlapping_timesheets\":0,\"show_timesheet_notes\":\"1\",\"pref_mandatory_notes\":0,\"pref_emp_can_edit_tc_without_providing_reason\":\"1\",\"pref_tc_tips\":\"1\",\"pref_timeclock_show_scheduled_details\":\"1\",\"pref_tc_screenshot\":0,\"pref_tc_screen_freq\":\"3\",\"pref_tc_screen_quality\":\"10\",\"pref_tc_screen_schedules\":null,\"pref_weekly_avail\":\"1\",\"pref_vacation_show_deleted\":0,\"pref_future_avail\":\"1\",\"pref_approve_availability\":\"1\",\"pref_sched_can_approve_past_vacations\":\"1\",\"pref_vac_req_only_schedulers\":0,\"pref_sched_can_approve_availability\":\"1\",\"pref_book_days_off\":\"1\",\"pref_book_days_off_adv\":\"-1\",\"pref_book_days_off_max\":\"30\",\"pref_vacation_max_days\":25,\"pref_availability_timeframe\":\"0\",\"pref_employee_delete_vacations\":\"1\",\"overtime_module\":\"default\",\"pref_cot_order15\":0,\"daily_overtime\":\"24\",\"overtime\":\"45\",\"monthly_overtime\":\"-2\",\"pref_request_deduct_breaks\":0,\"pref_currency\":\"1\",\"export_provider\":\"1\",\"company_code\":\"1111\",\"batch_id\":\"999\",\"fixed_batch_id\":\"1\",\"regular_hour_code\":\"101\",\"special_hour_code\":\"201\",\"overtime_hour_code\":\"301\",\"export_payrate\":0,\"company_name\":\"Shiftplanning\",\"company_created_time\":\"2016-04-14\",\"rate_of_pay\":\"\",\"pref_alt_w_overtime_calc\":0,\"pref_overtime_per_position\":0,\"pref_approve_overtime\":0,\"pref_allow_scheduler_to_see_wages\":0,\"pref_allow_scheduler_to_see_budget\":0,\"pref_allow_scheduler_to_edit_budget\":0,\"allow_schedulers_payroll_report\":0,\"num_of_decimals\":\"2\",\"pref_message_wall_on\":\"1\",\"pref_message_wall_emp\":\"1\",\"pref_message_wall_comments\":\"1\",\"pref_messaging_system\":\"1\",\"pref_pm\":\"1\",\"pref_ping\":\"1\",\"pref_login_google\":0,\"pref_login_facebook\":0,\"pref_login_twitter\":0,\"pref_login_openid\":0,\"pref_login_splogo\":0,\"autologout\":\"0\",\"password_expire\":\"0\",\"groupforce\":[],\"payroll\":{\"company_code\":\"1111\",\"batch_id\":\"999\",\"fixed_batch_id\":1,\"regular_hour_code\":\"101\",\"special_hour_code\":\"201\",\"overtime_hour_code\":\"301\",\"company_name\":\"Shiftplanning\",\"company_created_time\":\"2016-04-14\",\"export_provider\":\"1\",\"autologout\":\"0\",\"rate_of_pay\":\"\",\"export_payrate\":null,\"qb_position_to_item\":null,\"export_amount\":null},\"allow_multiple_filters_in_reports\":0,\"pref_only_managers_can_change_staff_password\":0,\"pref_employees_workunit_autoapproved\":0,\"pref_restrict_empl_clockinout\":0,\"pref_timeclock_show_breaks_mts\":\"1\",\"qb_position_to_item\":0,\"pref_messaging_module\":\"1\",\"pref_pm_reply\":\"1\",\"pref_leave_enabled\":\"1\",\"pref_integrations\":0,\"export_amount\":0}"
  },
  "error": null
}

Form Data

admin_past_edit
int32

enum[0,1]

book_days_off
int32

enum[0,1]

book_days_off_adv
int32

number of days

confirm_trade_after
int32

enum[0,1]

confirm_trade_before
int32

enum[0,1]

coworkers_contacts
int32

enum[0,1]

email
int32

enum[0,1]

future_avail
int32

enum[0,1]

message_wall_comments
int32

enum[0,1]

message_wall_emp
int32

enum[0,1]

message_wall_on
int32

enum[0,1]

on_now
int32

enum[0,1]

overtime
int32

Daily overtime - max number of hours

pm
int32

enum[0,1]

pref_allow_req_acc
int32

enum[0,1]

pref_alt_w_overtime_calc
int32

enum[0,1]

pref_availability_timeframe
int32

AvailabilityChangeRequests are effective 0 – Immediatly 1 – after one day 2 – after two days *7 – after one week

pref_birthday
int32

enum[0,1]

pref_birthday_card
int32

enum[0,1]

pref_birthday_reminder
int32

enum[0,1]

shift_confirm
int32

enum[0,1]

sms
int32

enum[0,1]

tc_autoclockout
int32

enum[0,1]

tc_clock_in_timeframe
int32
tc_round_to
int32
tc_terminal_lock
int32

enum[0,1]

tc_webcam
int32

enum[0,1]

timeclock
int32

enum[0,1]

trade_shifts
int32

enum[0,1]

visible_coworkers
int32

enum[0,1]

visible_overview
int32

enum[0,1]

visible_own
int32

enum[0,1]

visible_staff
int32

enum[0,1]

visible_staff_details
int32

enum[0,1]

weekly_avail
int32

enum[0,1]

 

Update information about company.

Suggest Edits

GET Number of requests

/company/number_of_requests
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/company/number_of_requests?access_token=xxxxxxxxxx
https://www.humanity.com//api/v2/company/number_of_requests?access_token=xxxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "total": 13,
        "vacation": 3,
        "shift_available": 0,
        "trade_available": 0,
        "shift_approval": 10,
        "shift_request_waiting": 0,
        "trade_approval": 0,
        "weekly_avail": 0,
        "future_avail": 0,
        "staff_requested": 0,
        "unacknowledged_shifts": "8",
        "work_units": 0
    },
    "token": "xxxxxxxx",
    "error": null
}
 

Returns a count of all requests

Suggest Edits

GET Business

/company/business
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/company/business?access_token=xxxxxxxxxx
https://www.humanity.com//api/v2/company/business?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": "303579",
        "franchise": "303579",
        "status": "1",
        "agent": "2969465",
        "hunter": null,
        "salessupport": null,
        "level": "1",
        "price": "105",
        "price_back": "0",
        "absplit": " ",
        "abversion": "0",
        "comticket": "454941",
        "timezone": "-05:00,0",
        "created": "1499693156",
        "deleted": "0",
        "created_day": "2994",
        "name": "\t\t\t\t\t\t    Alex incs",
        "domain": "alexinc1",
        "nemployees": "16",
        "billing_employees": "1",
        "logo": "1519922147",
        "address": "Mekenzijeva 21 ",
        "country": "189",
        "state": "00",
        "city": "Belgrade",
        "phone_number": "+381000000000",
        "fax_number": "",
        "user": "3475050",
        "start_day": "1",
        "end_day": "7",
        "start_time": "33",
        "end_time": "85",
        "24hr": "0",
        "overtime": "40",
        "industry": "21",
        "pref_admin_past_edit": "0",
        "pref_book_days_off": "1",
        "pref_book_days_off_adv": "-1",
        "pref_book_days_off_max": "3",
        "pref_confirm_trade_before": "1",
        "pref_confirm_trade_after": "1",
        "pref_sms": "1",
        "pref_email": "1",
        "pref_email_force": 0,
        "pref_pm": "1",
        "pref_visible_staff": "1",
        "pref_visible_staff_details": "1",
        "pref_visible_coworkers": "1",
        "pref_trade_shifts": "1",
        "pref_same_day_trades": "1",
        "pref_coworkers_contacts": "1",
        "pref_future_avail": "1",
        "pref_weekly_avail": "1",
        "pref_approve_availability": "1",
        "pref_visible_overview": "1",
        "pref_visible_own": "1",
        "pref_timeout": "1800",
        "pref_message_wall_on": "1",
        "pref_message_wall_emp": 0,
        "pref_message_wall_comments": "1",
        "pref_message_wall_uploads": "1",
        "pref_on_now": "1",
        "pref_shift_confirm": "1",
        "pref_shift_drop": 0,
        "pref_shift_autoconfirm": 0,
        "pref_timeclock": "1",
        "pref_tc_terminal_lock": 0,
        "pref_tc_round_to": "15",
        "pref_tc_round_to_in": "5",
        "pref_tc_round_to_out": "5",
        "pref_tc_clock_in_timeframe": "-1",
        "pref_tc_autoclockout": "9",
        "pref_tc_webcam": 0,
        "pref_tc_empl_import": "1",
        "pref_tc_empl_addtime": "1",
        "pref_tc_require_pos": 0,
        "pref_tc_require_notes": 0,
        "pref_24hr": "1",
        "pref_date": "d-m-Y",
        "pref_startday": "2",
        "pref_week_adjust": "-26",
        "pref_currency": "1",
        "pref_viewadvance": "-1",
        "pref_mintimebshifts": "0",
        "pref_draft": "1",
        "pref_reports": "1",
        "pref_edit_profile": 0,
        "pref_login_google": "1",
        "pref_login_facebook": 0,
        "pref_login_splogo": 0,
        "pref_login_twitter": "1",
        "pref_login_openid": "0",
        "pref_scosting": "3",
        "pref_training": "1",
        "pref_availability_timeframe": "28",
        "pref_alt_w_overtime_calc": 0,
        "settings": "{\"pref_timeclock\":\"1\",\"pref_enable_break_button\":\"1\",\"pref_leave_enabled\":\"1\",\"pref_book_days_off\":\"1\",\"pref_book_days_off_adv\":\"-1\",\"pref_training\":\"1\",\"pref_visible_staff\":\"1\",\"pref_visible_staff_details\":\"1\",\"pref_on_now\":\"1\",\"pref_shift_confirm\":\"1\",\"pref_confirm_trade_after\":\"1\",\"pref_swap_shifts\":\"1\",\"pref_tc_clock_in_timeframe\":\"-1\",\"pref_tc_clock_in_after_timeframe\":\"-1\",\"pref_tc_clock_out_timeframe\":\"-1\",\"pref_tc_clock_out_after_timeframe\":\"-1\",\"pref_vacation_weekdays\":\"[\\\"6\\\"]\",\"country\":\"189\",\"timezone_id\":\"152\",\"language\":\"en_US\",\"pref_date\":\"d-m-Y\",\"pref_24hr\":\"1\",\"pref_week_adjust\":\"-26\",\"pref_restrict_referrals\":0,\"pref_email\":\"1\",\"pref_sms\":\"1\",\"pref_email_force\":0,\"pref_birthday\":\"1\",\"pref_birthday_card\":\"1\",\"pref_training_to_pdf\":0,\"pref_employee_nameformat\":\"F L\",\"pref_reports\":\"1\",\"pref_edit_profile\":0,\"pref_staff_visible_eid\":0,\"pref_allow_req_acc\":0,\"security_question\":\"njjnnjjnjnjnjn\",\"security_answer\":\"\",\"pref_employee_files\":0,\"show_upcoming_birthdays\":\"1\",\"allow_schedulers_to_create_delete_users\":\"1\",\"allow_multiple_filters_in_reports\":0,\"pref_send_email_via_emailclient\":\"1\",\"pref_only_managers_can_change_staff_password\":0,\"pref_message_wall_on\":\"1\",\"pref_message_wall_emp\":0,\"pref_message_wall_comments\":\"1\",\"pref_messaging_module\":\"1\",\"pref_pm\":\"1\",\"pref_pm_reply\":\"1\",\"pref_ping\":\"1\",\"pref_login_facebook\":0,\"pref_login_splogo\":0,\"autologout\":\"0\",\"password_expire\":\"0\",\"sort_location\":0,\"pref_show_location_in_shift\":\"1\",\"pref_show_overnight_shifts\":\"1\",\"pref_startday\":\"2\",\"pref_draft\":\"1\",\"pref_tasks\":\"1\",\"pref_24h_shift\":0,\"pref_schedule_notes\":\"1\",\"pref_schedule_notes_permissions\":\"3\",\"do_not_initiate_conflicts\":0,\"pref_show_pending_leaves_on_schedule\":0,\"pref_see_shift_notes_perm\":\"7\",\"pref_viewadvance\":\"-1\",\"pref_scosting\":\"3\",\"pref_visible_overview\":\"1\",\"pref_visible_own\":\"1\",\"max_days_row\":\"5\",\"pref_show_midnight\":0,\"pref_oncall_manage\":0,\"pref_employee_see_vacations\":\"1\",\"pref_sched_show_skill\":0,\"pref_task_modal\":\"\",\"pref_trade_shifts\":\"1\",\"pref_same_day_trades\":\"1\",\"pref_dont_show_overlapping_shifts_in_trades\":\"1\",\"pref_disable_shift_trade_between_positions\":0,\"pref_confirm_trade_before\":\"1\",\"pref_shift_acknowledgement\":\"1\",\"pref_shift_acknowledgement_notify\":\"12\",\"pref_visible_coworkers\":\"1\",\"pref_shift_drop\":0,\"pref_shift_autoconfirm\":0,\"pref_open_overtime\":\"1\",\"pref_mintimebshifts\":\"0\",\"pref_min_disregard\":0,\"pref_work_units\":\"1\",\"pref_work_units_employees\":\"1\",\"pref_schedulers_workunit_autoapproved\":0,\"pref_employees_workunit_autoapproved\":0,\"pref_wu_emp_can_see_report\":\"1\",\"pref_tc_webcam\":0,\"pref_tc_webcam_mobile\":0,\"pref_webcam_resolution\":\"320\",\"pref_tc_gps\":\"1\",\"pref_tc_unavailable_gps\":0,\"pref_tc_address\":0,\"pref_pre_time_clock\":0,\"pref_mandatory_pre_time_clock\":0,\"pref_restrict_empl_clockinout\":0,\"pref_tc_terminal_lock\":0,\"pref_tc_require_pos\":0,\"pref_tc_require_remote_site\":0,\"pref_tc_require_notes\":0,\"pref_tc_autoclockout\":\"9\",\"pref_tc_tips\":0,\"pref_timeclock_show_scheduled_details\":\"1\",\"pref_timeclock_show_breaks_mts\":0,\"pref_restrict_overlapping_timesheets\":0,\"pref_tc_round_to\":\"15\",\"pref_tc_round_to_in\":\"5\",\"pref_tc_round_to_in_direction\":\"1\",\"pref_tc_round_to_out\":\"5\",\"pref_tc_round_to_out_direction\":\"-1\",\"pref_tc_empl_import\":\"1\",\"pref_tc_empl_addtime\":\"1\",\"pref_tc_empl_edittime\":\"1\",\"pref_tc_prevent_empl_edittime_approved\":0,\"pref_tc_prevent_empl_addclock_x_days\":\"0\",\"show_timesheet_notes\":0,\"pref_mandatory_notes\":0,\"pref_emp_can_edit_tc_without_providing_reason\":0,\"pref_admin_clockin_reminder_schedulers\":\"[]\",\"pref_admin_clockin_reminder_managers\":\"[]\",\"pref_admin_clockout_reminder_schedulers\":\"[]\",\"pref_admin_clockout_reminder_managers\":\"[]\",\"pref_weekly_avail\":\"1\",\"pref_future_avail\":\"1\",\"pref_approve_availability\":\"1\",\"pref_sched_can_approve_availability\":\"1\",\"pref_availability_timeframe\":\"28\",\"pref_vacation_show_deleted\":0,\"pref_vac_req_only_schedulers\":0,\"pref_sched_can_approve_past_vacations\":0,\"pref_book_days_off_max\":\"3\",\"pref_vacation_max_days\":\"20\",\"pref_employee_delete_vacations\":\"1\",\"overtime_module\":\"default\",\"pref_cot_order15\":0,\"daily_overtime\":\"8\",\"overtime\":\"40\",\"monthly_overtime\":\"-2\",\"pref_request_deduct_breaks\":0,\"pref_payroll_reports\":0,\"rate_of_pay\":\"\",\"pref_alt_w_overtime_calc\":0,\"pref_overtime_per_position\":0,\"pref_approve_overtime\":0,\"pref_allow_scheduler_to_see_wages\":0,\"pref_allow_scheduler_to_see_budget\":0,\"pref_allow_scheduler_to_edit_budget\":0,\"allow_schedulers_payroll_report\":0,\"num_of_decimals\":\"2\",\"export_provider\":\"18\",\"pref_currency\":\"1\",\"company_code\":\"\",\"batch_id\":\"\",\"fixed_batch_id\":\"1\",\"regular_hour_code\":\"123\",\"special_hour_code\":\"AAA\",\"overtime_hour_code\":\"1111\",\"export_payrate\":\"1\",\"export_amount\":\"1\",\"company_name\":\"\",\"company_created_time\":\"\",\"qb_position_to_item\":0,\"payroll\":{\"company_code\":\"\",\"batch_id\":\"\",\"fixed_batch_id\":1,\"regular_hour_code\":\"123\",\"special_hour_code\":\"AAA\",\"overtime_hour_code\":\"1111\",\"company_name\":\"\",\"company_created_time\":\"\",\"export_provider\":\"18\",\"rate_of_pay\":\"\",\"export_payrate\":\"1\",\"qb_position_to_item\":null,\"export_amount\":\"1\",\"tax_frequency\":\"\"},\"groupforce\":{\"overtime_module\":1,\"daily_overtime\":1,\"overtime\":1,\"pref_request_deduct_breaks\":1,\"pref_payroll_reports\":1},\"pref_include_ghost_shifts\":\"0\",\"geofencing_distance\":null,\"tax_frequency\":\"\"}",
        "notes": "",
        "created_by": "0",
        "new_employee_note": "",
        "personal_welcome_sent": "0",
        "ical": "7ed659924dbecf689b8f8d2847b6a225",
        "trial": "205",
        "trial_expiration": "2018-01-31",
        "nonprofit": "0",
        "casestudy": "0",
        "paid_until": "0",
        "paid_until_date": null,
        "next_payment_date": null,
        "groupbilling": "0",
        "setup": "0",
        "aw_keyword": " ",
        "campaign": " ",
        "affiliate": " ",
        "promo": " ",
        "saml_enabled": "0",
        "saml_allow_login": "0",
        "saml_login_url": "",
        "saml_logout_url": "",
        "saml_certificate": "",
        "saml_fingerprint": "",
        "language": "en_US",
        "daily_overtime": "8",
        "pref_min_disregard": 0,
        "max_days_row": "5",
        "pref_tc_screenshot": "0",
        "group_platform_settings": "",
        "pref_vacation_max_days": "20",
        "sort_location": 0,
        "pref_training_to_pdf": 0,
        "pref_pre_time_clock": 0,
        "pref_mandatory_pre_time_clock": 0,
        "pref_user_confirm": "0",
        "pref_request_deduct_breaks": 0,
        "timezone_id": "152",
        "pref_enable_break_button": "1",
        "pref_ping": "1",
        "pref_open_overtime": "1",
        "pref_show_location_in_shift": "1",
        "pref_swap_shifts": "1",
        "monthly_overtime": "-2",
        "health": "88",
        "pref_show_midnight": 0,
        "pref_overtime_per_position": 0,
        "pref_approve_overtime": 0,
        "pref_birthday": "1",
        "pref_birthday_card": "1",
        "pref_birthday_reminder": "1",
        "logo_url": "{\"large\":\"logos\\/303579-5a982be3b3213.jpg\",\"small\":\"logos\\/sm_303579-5a982be3b3213.jpg\",\"full\":\"logos\\/full_303579-5a982be3b3213.jpg\",\"large_url\":\"https:\\/\\/s3.amazonaws.com\\/uf.shiftplanning.com\\/logos%2F303579-5a982be3b3213.jpg\",\"small_url\":\"https:\\/\\/s3.amazonaws.com\\/uf.shiftplanning.com\\/logos%2Fsm_303579-5a982be3b3213.jpg\",\"full_url\":\"https:\\/\\/s3.amazonaws.com\\/uf.shiftplanning.com\\/logos%2Ffull_303579-5a982be3b3213.jpg\"}",
        "pref_tc_clock_out_timeframe": "-1",
        "pref_tc_empl_edittime": "1",
        "background_url": null,
        "pref_allow_req_acc": 0,
        "security_question": "njjnnjjnjnjnjn",
        "security_answer": "",
        "pref_employee_nameformat": "F L",
        "background": "0",
        "pref_tc_gps": "1",
        "pref_oncall_manage": 0,
        "pref_referrals": "0",
        "custombilling": "0",
        "master": "303579",
        "parent": "0",
        "is_parent": "1",
        "extra_setup": null,
        "saml_cache": null,
        "error_trial": "0",
        "is_humanity": null,
        "pref_dont_show_overlapping_shifts_in_trades": "1",
        "pref_tc_timeframe_notify": "0",
        "leadspecialist": "0",
        "newsletter_receive_type": "0",
        "shiftplanning_plus": "0",
        "had_wrong_timezone": "0",
        "aw_source": " ",
        "aw_medium": " ",
        "aw_campaign": " ",
        "aw_adgroup": " ",
        "aw_content": " ",
        "aw_term": " ",
        "company_id": "0",
        "contact_id": "0",
        "ambassador": " ",
        "ambassador_payed": "0",
        "store_id": null,
        "intercom_id": "596380cd6b3638d9f65ab12a",
        "pref_shift_acknowledgement": "1",
        "pref_shift_acknowledgement_notify": "12",
        "partner": " ",
        "downgrade": "0",
        "sign_up_url_without_params": "https://www.humanity.com/",
        "sign_up_url_with_params": "https://www.humanity.com/",
        "teamtools_id": "596381c9dab5b5ab12491d59",
        "onboarding": "",
        "unique_id": null,
        "use_parent_logo": false,
        "pref_leave_enabled": "1",
        "pref_tc_clock_in_after_timeframe": "-1",
        "pref_tc_clock_out_after_timeframe": "-1",
        "pref_vacation_weekdays": [
            "6"
        ],
        "pref_restrict_referrals": 0,
        "pref_staff_visible_eid": 0,
        "pref_employee_files": 0,
        "show_upcoming_birthdays": "1",
        "allow_schedulers_to_create_delete_users": "1",
        "allow_multiple_filters_in_reports": 0,
        "pref_send_email_via_emailclient": "1",
        "pref_only_managers_can_change_staff_password": 0,
        "pref_messaging_module": "1",
        "pref_pm_reply": "1",
        "autologout": "0",
        "password_expire": "0",
        "pref_show_overnight_shifts": "1",
        "pref_tasks": "1",
        "pref_24h_shift": 0,
        "pref_schedule_notes": "1",
        "pref_schedule_notes_permissions": "3",
        "do_not_initiate_conflicts": 0,
        "pref_show_pending_leaves_on_schedule": 0,
        "pref_see_shift_notes_perm": "7",
        "pref_employee_see_vacations": "1",
        "pref_sched_show_skill": 0,
        "pref_task_modal": "",
        "pref_disable_shift_trade_between_positions": 0,
        "pref_work_units": "1",
        "pref_work_units_employees": "1",
        "pref_schedulers_workunit_autoapproved": 0,
        "pref_employees_workunit_autoapproved": 0,
        "pref_wu_emp_can_see_report": "1",
        "pref_tc_webcam_mobile": 0,
        "pref_webcam_resolution": "320",
        "pref_tc_unavailable_gps": 0,
        "pref_tc_address": 0,
        "pref_restrict_empl_clockinout": 0,
        "pref_tc_require_remote_site": 0,
        "pref_tc_tips": 0,
        "pref_timeclock_show_scheduled_details": "1",
        "pref_timeclock_show_breaks_mts": 0,
        "pref_restrict_overlapping_timesheets": 0,
        "pref_tc_round_to_in_direction": "1",
        "pref_tc_round_to_out_direction": "-1",
        "pref_tc_prevent_empl_edittime_approved": 0,
        "pref_tc_prevent_empl_addclock_x_days": "0",
        "show_timesheet_notes": 0,
        "pref_mandatory_notes": 0,
        "pref_emp_can_edit_tc_without_providing_reason": 0,
        "pref_admin_clockin_reminder_schedulers": "[]",
        "pref_admin_clockin_reminder_managers": "[]",
        "pref_admin_clockout_reminder_schedulers": "[]",
        "pref_admin_clockout_reminder_managers": "[]",
        "pref_sched_can_approve_availability": "1",
        "pref_vacation_show_deleted": 0,
        "pref_vac_req_only_schedulers": 0,
        "pref_sched_can_approve_past_vacations": 0,
        "pref_employee_delete_vacations": "1",
        "overtime_module": "default",
        "pref_cot_order15": 0,
        "pref_payroll_reports": 0,
        "rate_of_pay": "",
        "pref_allow_scheduler_to_see_wages": 0,
        "pref_allow_scheduler_to_see_budget": 0,
        "pref_allow_scheduler_to_edit_budget": 0,
        "allow_schedulers_payroll_report": 0,
        "num_of_decimals": "2",
        "export_provider": "18",
        "company_code": "",
        "batch_id": "",
        "fixed_batch_id": "1",
        "regular_hour_code": "123",
        "special_hour_code": "AAA",
        "overtime_hour_code": "1111",
        "export_payrate": "1",
        "export_amount": "1",
        "company_name": "",
        "company_created_time": "",
        "qb_position_to_item": 0,
        "payroll": {
            "company_code": "",
            "batch_id": "",
            "fixed_batch_id": 1,
            "regular_hour_code": "123",
            "special_hour_code": "AAA",
            "overtime_hour_code": "1111",
            "company_name": "",
            "company_created_time": "",
            "export_provider": "18",
            "rate_of_pay": "",
            "export_payrate": "1",
            "qb_position_to_item": null,
            "export_amount": "1",
            "tax_frequency": ""
        },
        "groupforce": {
            "overtime_module": 1,
            "daily_overtime": 1,
            "overtime": 1,
            "pref_request_deduct_breaks": 1,
            "pref_payroll_reports": 1
        },
        "pref_include_ghost_shifts": "0",
        "geofencing_distance": null,
        "tax_frequency": ""
    },
    "token": "xxxxxxxxx",
    "error": null
}
 

Retrieves business details

Suggest Edits

GET Group permisions

/company/group_perms
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/company/group_perms?access_token=xxxxxx
https://www.humanity.com//api/v2/company/group_perms?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": [
        {
            "user": "3475050",
            "read": 1,
            "write": 1,
            "can_add_account": 1,
            "can_access_account": 1,
            "updated": null,
            "id": "3475050",
            "name": "Alex George"
        }
    ],
    "token": "xxxxxxxx",
    "error": null
}
 

Retrieves group permissions for authenticated user

Suggest Edits

GET Locations

/locations
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/locations
https://www.humanity.com/api/v2/locations?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": [
    {
      "id": 542311,
      "name": "Dream Coffee Shop 2",
      "country": "NL",
      "address": "Wijde Heisteeg 4, 1016 AS Amsterdam, Netherlands",
      "lat": 52.3687499,
      "lon": 4.8875525,
      "store": 251300,
      "type": 1,
      "notes": "",
      "timezone_id": 311,
      "map": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Wijde+Heisteeg+4%2C+1016+AS+Amsterdam%2C+Netherlands%2C+NL",
      "directions": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Wijde+Heisteeg+4%2C+1016+AS+Amsterdam%2C+Netherlands%2C+NL"
    },
    {
      "id": 542312,
      "name": "Dream Coffee Takeaway",
      "country": "RS",
      "address": "Kneginje Zorke 25, Beograd 11000, Serbia",
      "lat": 44.80096,
      "lon": 20.4691562,
      "store": 251300,
      "type": 2,
      "notes": "coffee takeaway",
      "timezone_id": 314,
      "map": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Kneginje+Zorke+25%2C+Beograd+11000%2C+Serbia%2C+RS",
      "directions": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Kneginje+Zorke+25%2C+Beograd+11000%2C+Serbia%2C+RS"
    }
  ],
  "token": "xxxxxxx"
}

Query Params

type
int32

enum[1,2] -> 1: Location; 2: Remote sites

 

Returns a list of all Locations.

Suggest Edits

GET Location

/locations/:id
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/locations/id
https://www.humanity.com/api/v2/locations/542311?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 542311,
    "name": "Dream Coffee Shop 2",
    "country": "NL",
    "address": "Wijde Heisteeg 4, 1016 AS Amsterdam, Netherlands",
    "lat": 52.3687499,
    "lon": 4.8875525,
    "store": 251300,
    "type": 1,
    "notes": "",
    "timezone_id": 311,
    "map": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Wijde+Heisteeg+4%2C+1016+AS+Amsterdam%2C+Netherlands%2C+NL",
    "directions": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Wijde+Heisteeg+4%2C+1016+AS+Amsterdam%2C+Netherlands%2C+NL"
  },
  "token": "xxxxxxx"
}

Path Params

id
int32
required

Location id

 

Retrieves an individual location specified by id.

Suggest Edits

POST Location

/locations
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/locations
https://www.humanity.com/api/v2/locations?access_token=xxxxxxx
name=Dream Coffee Takeaway
type=2
address=Ulica Kneza Milosa
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 542317,
    "name": "Dream Coffee Takeaway",
    "country": "",
    "address": "Ulica Kneza Milosa",
    "lat": "",
    "lon": "",
    "store": 251300,
    "type": 2,
    "notes": "",
    "timezone_id": null,
    "map": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Ulica+Kneza+Milosa%2C+",
    "directions": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Ulica+Kneza+Milosa%2C+"
  },
  "token": "xxxxxxx"
}

Form Data

name
string
required
type
int32
required

enum (1, 2) -> 1: Location; 2: Remote Site

country
string
address
string
lat
string
lon
string
timezone_id
int32
store
int32
 

Creates new location.

Suggest Edits

PUT Location

/locations/:id
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/locations/id
https://www.humanity.com/api/v2/locations/542317?access_token=xxxxxxx
name=Dream Coffee Center
address=Dobracina 30 Belgrade
country=Serbia
notes=This is our location in the center of the town
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 542317,
    "name": "Dream Coffee Center",
    "country": "Serbia",
    "address": "Dobracina 30 Belgrade",
    "lat": 0,
    "lon": 0,
    "store": 251300,
    "type": 2,
    "notes": "This is our location in the center of the town",
    "timezone_id": null,
    "map": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Dobracina+30+Belgrade%2C+Serbia",
    "directions": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=Dobracina+30+Belgrade%2C+Serbia"
  },
  "token": "xxxxxxx"
}

Path Params

id
int32
required

Location id

Form Data

name
string
required
country
string
address
string
lat
string
lon
string
timezone_id
int32
notes
string
phone_number
string
 

Updates location.

Suggest Edits

DELETE Location

/locations/:id
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://www.humanity.com/api/v2/locations/id
https://www.humanity.com/api/v2/locations/542317?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": "Remote Site Removed",
  "token": "xxxxxxx"
}

Path Params

id
int32
required

Location id

 

Deletes location.

Suggest Edits

GET Positions

/positions
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/positions
https://www.humanity.com/api/v2/positions?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": [
    {
      "id": 1321636,
      "name": "Desk Service",
      "start_time": {
        "id": 1,
        "time": "12 am"
      },
      "end_time": {
        "id": 97,
        "time": "midnight"
      },
      "color": 11,
      "ical": "https://www.humanity.shiftplanning.com/ical/-89ec2cc0b3e7ef6e44095846bd6d2e8e.ics?1470147114000",
      "visible": 1,
      "notify": 1,
      "job_code": null
    },
    {
      "id": 1321634,
      "name": "Manager",
      "start_time": {
        "id": 1,
        "time": "12 am"
      },
      "end_time": {
        "id": 97,
        "time": "midnight"
      },
      "color": 35,
      "ical": "https://www.humanity.shiftplanning.com/ical/-6d2b8705db43a1d8bbea824fea161b6e.ics?1470147114000",
      "visible": 1,
      "notify": 1,
      "job_code": null
    },
    {
      "id": 1321635,
      "name": "Waiter",
      "start_time": {
        "id": 1,
        "time": "12 am"
      },
      "end_time": {
        "id": 97,
        "time": "midnight"
      },
      "color": 10,
      "ical": "https://www.humanity.shiftplanning.com/ical/-45475a74c9611db9d25be71430ac64fa.ics?1470147114000",
      "visible": 1,
      "notify": 1,
      "job_code": null
    },
    {
      "id": 1324358,
      "name": "Barista",
      "start_time": {
        "id": 1,
        "time": "12 am"
      },
      "end_time": {
        "id": 97,
        "time": "midnight"
      },
      "color": 1,
      "ical": "https://www.humanity.shiftplanning.com/ical/-37733a1cb62de97f9ad4d35893e30cf0.ics?1470147114000",
      "visible": 1,
      "notify": 1,
      "job_code": null,
      "location": {
        "id": 542311,
        "name": "Dream Coffee Shop 2"
      }
    },
    {
      "id": 1324361,
      "name": "Customer service",
      "start_time": {
        "id": 1,
        "time": "12 am"
      },
      "end_time": {
        "id": 97,
        "time": "midnight"
      },
      "color": 25,
      "ical": "https://www.humanity.shiftplanning.com/ical/-5d7b3b4233e327aba088330a1a58e979.ics?1470147114000",
      "visible": 1,
      "notify": 1,
      "job_code": null,
      "location": {
        "id": 542311,
        "name": "Dream Coffee Shop 2"
      }
    },
    {
      "id": 1324363,
      "name": "Shop Manager",
      "start_time": {
        "id": 1,
        "time": "12 am"
      },
      "end_time": {
        "id": 97,
        "time": "midnight"
      },
      "color": 29,
      "ical": "https://www.humanity.shiftplanning.com/ical/-a52ba34da2ce034f9faa93f3ca05515b.ics?1470147114000",
      "visible": 1,
      "notify": 1,
      "job_code": null,
      "location": {
        "id": 542311,
        "name": "Dream Coffee Shop 2"
      }
    }
  ],
  "token": "xxxxxxx"
}

Query Params

perms
int32

enum[1] -> 1: Show perms

 

Returns a list of all Positions.

Suggest Edits

GET Position

/positions/:id
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/positions/id
https://www.humanity.com/api/v2/positions/1324361?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 1324361,
    "name": "Customer service",
    "start_time": {
      "id": 1,
      "time": "12 am"
    },
    "end_time": {
      "id": 97,
      "time": "midnight"
    },
    "color": 25,
    "ical": "https://www.humanity.shiftplanning.com/ical/-5d7b3b4233e327aba088330a1a58e979.ics?1470147186000",
    "visible": 1,
    "notify": 1,
    "job_code": null,
    "location": {
      "id": 542311,
      "name": "Dream Coffee Shop 2"
    }
  },
  "token": "xxxxxxx"
}

Path Params

id
int32
required

Position id

 

Retrieves an individual Position.

Suggest Edits

POST Position

/positions
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/positions
https://www.humanity.com/api/v2/positions?access_token=xxxxxxx
name=Dishwasher
active=1
location=542312
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 1324481,
    "name": "Dishwasher",
    "start_time": {
      "id": 1,
      "time": "12 am"
    },
    "end_time": {
      "id": 97,
      "time": "midnight"
    },
    "color": 1,
    "ical": "https://www.humanity.shiftplanning.com/ical/-8bcb5fb6197445930ec0d7fc34cd5b3f.ics?1470147335000",
    "visible": 1,
    "notify": 1,
    "job_code": null,
    "location": {
      "id": 542312,
      "name": "Dream Coffee Takeaway"
    }
  },
  "token": "xxxxxxx"
}

Form Data

name
string
required
active
string

enum [1, -1] -> -1: Inactive; 1: Active

start_time
date
end_time
date
color
int32
location
int32
visible
int32

enum [0, 1]

 

Creates an individual Position.

Suggest Edits

PUT Position

/positions/:id
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/positions/id
name=Store Manager
active=1
color=27
https://www.humanity.com/api/v2/positions/1321634?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 1321634,
    "name": "Store Manager",
    "start_time": {
      "id": 1,
      "time": "12 am"
    },
    "end_time": {
      "id": 97,
      "time": "midnight"
    },
    "color": 27,
    "ical": "https://www.humanity.shiftplanning.com/ical/-6d2b8705db43a1d8bbea824fea161b6e.ics?1470147562000",
    "visible": 1,
    "notify": 1,
    "job_code": null
  },
  "token": "xxxxxxx"
}

Path Params

id
int32
required

Position id

Form Data

active
string

enum [1, -1] -> -1: Inactive; 1: Active

job_code
string
name
string
start_time
date
end_time
date
color
int32
location
int32
visible
int32

enum [0, 1]

 

Updates an individual Position.

Suggest Edits

DELETE Position

/positions/:id
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://www.humanity.com/api/v2/positions/id
https://www.humanity.com/api/v2/positions/1324481?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": "",
  "token": "xxxxxxx"
}

Path Params

id
int32
required

Position id

 

Deletes an individual Position.

Suggest Edits

DELETE Position break rules

/positions
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/breakrules/id?access_token=xxxxxxx
https://www.humanity.engineering/api/v2/breakrules/244648?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": "Breakrule Removed",
    "token": "xxxxxx",
    "error": null
}

Query Params

id
int32

Break rule id

 

Deletes a break rule

Suggest Edits

GET Employees

/employees
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/employees
https://www.humanity.com/api/v2/employees?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": [
    {
      "id": "2736727",
      "language": null,
      "work_start_date": "2016-07-29 16:37:00",
      "eid": "",
      "name": "Brian Lane",
      "firstname": "Brian",
      "lastname": "Lane",
      "username": "publicapitest",
      "email": "milos.tomic+pubapitest@shiftplanning.com",
      "group": "2",
      "status": "1",
      "wage": "",
      "nick_name": "",
      "birth_day": "0",
      "birth_month": "0",
      "cell_phone": "",
      "home_phone": "",
      "avatar": {
        "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png"
      },
      "avatar_url": null,
      "address": "",
      "city": "",
      "state": "",
      "zip": "",
      "notes": "",
      "ical": "https://www.humanity.shiftplanning.com/ical/869e0e6a380543a59443f360d49fa0fb.ics",
      "registered": "1469803042",
      "last_active": "1470140978",
      "p_phone": "1",
      "p_email": "1",
      "location": "0",
      "timezone": "314",
      "schedules": {
        "1321634": "Manager"
      },
      "skills": {
        "96398": "sales",
        "96403": "managing",
        "96404": "leadership"
      },
      "timezone_name": "Europe/Belgrade",
      "group_name": "Manager",
      "status_name": "Activated",
      "custom": []
    },
    {
      "id": "2744092",
      "language": null,
      "work_start_date": "2016-08-02 00:00:00",
      "eid": "",
      "name": "Derrick Arnold",
      "firstname": "Derrick",
      "lastname": "Arnold",
      "username": "derrick.arnoldpublicapite",
      "email": "derrick.arnold@publicapitest.com",
      "group": "5",
      "status": "1",
      "wage": "",
      "nick_name": "",
      "birth_day": "0",
      "birth_month": "0",
      "cell_phone": "",
      "home_phone": "",
      "avatar": {
        "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png"
      },
      "avatar_url": null,
      "address": "",
      "city": "",
      "state": "",
      "zip": "",
      "notes": "",
      "ical": "https://www.humanity.shiftplanning.com/ical/fc49f14c15399bdf4bed02ebf6ac4331.ics",
      "registered": "1470130086",
      "last_active": "0",
      "p_phone": "1",
      "p_email": "1",
      "location": "0",
      "timezone": "314",
      "schedules": {
        "1321636": "Desk Service"
      },
      "skills": {
        "96399": "coffee preparing",
        "96402": "tea"
      },
      "timezone_name": "Europe/Belgrade",
      "group_name": "Employee",
      "status_name": "Activated",
      "custom": []
    },
    {
      "id": "2744093",
      "language": null,
      "work_start_date": "2016-08-02 00:00:00",
      "eid": "",
      "name": "Frederick Braxton",
      "firstname": "Frederick",
      "lastname": "Braxton",
      "username": "frederick.braxtonpublicap",
      "email": "frederick.braxton@publicapitest.com",
      "group": "5",
      "status": "1",
      "wage": "",
      "nick_name": "",
      "birth_day": "0",
      "birth_month": "0",
      "cell_phone": "",
      "home_phone": "",
      "avatar": {
        "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png"
      },
      "avatar_url": null,
      "address": "",
      "city": "",
      "state": "",
      "zip": "",
      "notes": "",
      "ical": "https://www.humanity.shiftplanning.com/ical/c772c6bb9efda68a0f5cd8809668f00c.ics",
      "registered": "1470130086",
      "last_active": "0",
      "p_phone": "1",
      "p_email": "1",
      "location": "0",
      "timezone": "314",
      "schedules": {
        "1321635": "Waiter"
      },
      "skills": {
        "96399": "coffee preparing"
      },
      "timezone_name": "Europe/Belgrade",
      "group_name": "Employee",
      "status_name": "Activated",
      "custom": []
    },
    {
      "id": "2744094",
      "language": null,
      "work_start_date": "2016-08-02 00:00:00",
      "eid": "",
      "name": "Josephine P. Watson",
      "firstname": "Josephine P.",
      "lastname": "Watson",
      "username": "josephine.watsonpublicapi",
      "email": "josephine.watson@publicapitest.com",
      "group": "5",
      "status": "1",
      "wage": "",
      "nick_name": "",
      "birth_day": "0",
      "birth_month": "0",
      "cell_phone": "",
      "home_phone": "",
      "avatar": {
        "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png"
      },
      "avatar_url": null,
      "address": "",
      "city": "",
      "state": "",
      "zip": "",
      "notes": "",
      "ical": "https://www.humanity.shiftplanning.com/ical/512454f69f62b183e1fefda8b0530181.ics",
      "registered": "1470130086",
      "last_active": "0",
      "p_phone": "1",
      "p_email": "1",
      "location": "0",
      "timezone": "314",
      "schedules": {
        "1324361": "Customer service"
      },
      "skills": {
        "96398": "sales",
        "96402": "tea"
      },
      "timezone_name": "Europe/Belgrade",
      "group_name": "Employee",
      "status_name": "Activated",
      "custom": []
    },
    {
      "id": "2744095",
      "language": null,
      "work_start_date": "2016-08-02 00:00:00",
      "eid": "",
      "name": "Kian Simonette",
      "firstname": "Kian",
      "lastname": "Simonette",
      "username": "kian.simonettepublicapite",
      "email": "kian.simonette@publicapitest.com",
      "group": "5",
      "status": "1",
      "wage": "",
      "nick_name": "",
      "birth_day": "0",
      "birth_month": "0",
      "cell_phone": "",
      "home_phone": "",
      "avatar": {
        "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png"
      },
      "avatar_url": null,
      "address": "",
      "city": "",
      "state": "",
      "zip": "",
      "notes": "",
      "ical": "https://www.humanity.shiftplanning.com/ical/eefcee5502754393785623b55a2a733c.ics",
      "registered": "1470130086",
      "last_active": "0",
      "p_phone": "1",
      "p_email": "1",
      "location": "0",
      "timezone": "314",
      "schedules": {
        "1324358": "Barista"
      },
      "skills": {
        "96399": "coffee preparing",
        "96405": "cooking"
      },
      "timezone_name": "Europe/Belgrade",
      "group_name": "Employee",
      "status_name": "Activated",
      "custom": []
    },
    {
      "id": "2744096",
      "language": null,
      "work_start_date": "2016-08-02 00:00:00",
      "eid": "",
      "name": "Michael Rivas",
      "firstname": "Michael",
      "lastname": "Rivas",
      "username": "michael.rivaspublicapites",
      "email": "michael.rivas@publicapitest.com",
      "group": "5",
      "status": "1",
      "wage": "",
      "nick_name": "",
      "birth_day": "0",
      "birth_month": "0",
      "cell_phone": "",
      "home_phone": "",
      "avatar": {
        "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png"
      },
      "avatar_url": null,
      "address": "",
      "city": "",
      "state": "",
      "zip": "",
      "notes": "",
      "ical": "https://www.humanity.shiftplanning.com/ical/7cd9660f6345a981d9deeac801309b1f.ics",
      "registered": "1470130086",
      "last_active": "0",
      "p_phone": "1",
      "p_email": "1",
      "location": "0",
      "timezone": "314",
      "schedules": {
        "1324361": "Customer service",
        "1324363": "Shop Manager"
      },
      "skills": {
        "96398": "sales",
        "96401": "stock checks",
        "96402": "tea",
        "96404": "leadership"
      },
      "timezone_name": "Europe/Belgrade",
      "group_name": "Employee",
      "status_name": "Activated",
      "custom": []
    },
    {
      "id": "2744097",
      "language": null,
      "work_start_date": "2016-08-02 00:00:00",
      "eid": "",
      "name": "Sheri Downer",
      "firstname": "Sheri",
      "lastname": "Downer",
      "username": "sheri.downerpublicapitest",
      "email": "sheri.downer@publicapitest.com",
      "group": "5",
      "status": "1",
      "wage": "",
      "nick_name": "",
      "birth_day": "0",
      "birth_month": "0",
      "cell_phone": "",
      "home_phone": "",
      "avatar": {
        "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png"
      },
      "avatar_url": null,
      "address": "",
      "city": "",
      "state": "",
      "zip": "",
      "notes": "",
      "ical": "https://www.humanity.shiftplanning.com/ical/c9b5846d1e2b98faf40a5a6d0b579a14.ics",
      "registered": "1470130086",
      "last_active": "0",
      "p_phone": "1",
      "p_email": "1",
      "location": "0",
      "timezone": "314",
      "schedules": {
        "1321635": "Waiter",
        "1324361": "Customer service"
      },
      "skills": {
        "96398": "sales",
        "96399": "coffee preparing",
        "96403": "managing"
      },
      "timezone_name": "Europe/Belgrade",
      "group_name": "Employee",
      "status_name": "Activated",
      "custom": []
    },
    {
      "id": "2744098",
      "language": null,
      "work_start_date": "2016-08-02 00:00:00",
      "eid": "",
      "name": "Timothy Edison",
      "firstname": "Timothy",
      "lastname": "Edison",
      "username": "timothy.edisonpublicapite",
      "email": "timothy.edison@publicapitest.com",
      "group": "5",
      "status": "1",
      "wage": "",
      "nick_name": "",
      "birth_day": "0",
      "birth_month": "0",
      "cell_phone": "",
      "home_phone": "",
      "avatar": {
        "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png"
      },
      "avatar_url": null,
      "address": "",
      "city": "",
      "state": "",
      "zip": "",
      "notes": "",
      "ical": "https://www.humanity.shiftplanning.com/ical/5346217520c38676cb9a18a8aa6317f9.ics",
      "registered": "1470130086",
      "last_active": "0",
      "p_phone": "1",
      "p_email": "1",
      "location": "0",
      "timezone": "314",
      "schedules": {
        "1321635": "Waiter",
        "1324358": "Barista"
      },
      "skills": {
        "96400": "serving sandwiches and cakes",
        "96402": "tea",
        "96405": "cooking"
      },
      "timezone_name": "Europe/Belgrade",
      "group_name": "Employee",
      "status_name": "Activated",
      "custom": []
    }
  ],
  "token": "xxxxxxx"
}

Query Params

schedule
int32

Position ID. Parameter for filtering purpose. If set, only employees assigned on that position will be fetched.

location
int32

Location ID

disabled
int32

enum [1] -> 1: Return disabled employees

inactive
int32

enum [1] -> 1: Return inactive employees

with_custom_fields
int32

enum[0,1] -> 0: Do not retrieve employee custom fields; 1: Retrieve employee custom fields

scheduler_users
int32

enum [1] -> 1: Retrieves staff user that can see on schedule if staff gallery is off

check_permission
int32

enum [1]

 

Returns array of all employees (activated, not activated). If you have specified schedule or location, it will return array of all employees related to specified schedule or location. Disabled employees can be retrieved with parameter "disabled":1, Not activated employees can be retrieved with "inactive":1

Suggest Edits

GET Employee

/employees/:id
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/employees/id
https://www.humanity.com/api/v2/employees/2744094?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": "2744094",
    "username": "josephine.watsonpublicapi",
    "tusername": "",
    "email": "josephine.watson@publicapitest.com",
    "title": null,
    "realname": "Josephine P. Watson",
    "url": null,
    "jabber": null,
    "icq": null,
    "msn": null,
    "aim": null,
    "yahoo": null,
    "location": "0",
    "signature": null,
    "disp_topics": null,
    "disp_posts": null,
    "email_setting": "1",
    "notify_with_post": "0",
    "auto_notify": "0",
    "show_smilies": "1",
    "show_img": "1",
    "show_img_sig": "1",
    "show_avatars": "1",
    "show_sig": "1",
    "access_keys": "0",
    "timezone": "314",
    "dst": "0",
    "time_format": "0",
    "date_format": "0",
    "language": null,
    "style": "ShiftPlanning",
    "num_posts": "0",
    "last_post": null,
    "last_search": null,
    "last_email_sent": null,
    "registered": "1470130086",
    "registration_ip": "0.0.0.0",
    "last_visit": "0",
    "last_active": "0",
    "admin_note": null,
    "activate_string": null,
    "activate_key": null,
    "pun_bbcode_enabled": "1",
    "pun_bbcode_use_buttons": "1",
    "pun_pm_new_messages": null,
    "pun_pm_long_subject": "1",
    "newsletter": "1",
    "email_confirmed": "0",
    "eid": "",
    "status": "1",
    "deleted": "0",
    "deleted_by": "0",
    "legal_agree": "0",
    "referral": "0",
    "wage": "",
    "name": "Josephine P. Watson",
    "firstname": "Josephine P.",
    "lastname": "Watson",
    "nick_name": "",
    "birth_day": "0",
    "birth_month": "0",
    "smsgateway": null,
    "cell_phone": "",
    "cellphone_confirmed": "0",
    "last_sms_sent": "0",
    "home_phone": "",
    "avatar": {
      "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
      "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
      "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png"
    },
    "address": "",
    "city": "",
    "state": "",
    "zip": "",
    "notes": "",
    "p_email": "1",
    "p_phone": "1",
    "notify_sms": "-1",
    "notify_email": "1",
    "e_new_pm": "0",
    "ical": "https://www.humanity.shiftplanning.com/ical/512454f69f62b183e1fefda8b0530181.ics",
    "24hr": "0",
    "startday": "1",
    "pref_caltime": "10",
    "pref_shift_autoconfirm": "-1",
    "undertime": "0",
    "overtime": "-1",
    "recommend": "0",
    "recommendation": "",
    "tut_v2_sched": "0",
    "daily_overtime": "0",
    "max_days_row": "-1",
    "pref_vacation_max_days": "-1",
    "timezone_id": null,
    "monthly_undertime": "0",
    "monthly_overtime": "-1",
    "pref_mtimebshifts": "0",
    "avatar_url": null,
    "deactivated": "0",
    "work_start_date": "2016-08-02 00:00:00",
    "screen_logger": "0",
    "sc_freq": "-2",
    "newsletter_receiver": "0",
    "job_title": "",
    "middle_name": "",
    "gender": null,
    "pref_sp_skin": "0",
    "inline_wizard_completion": null,
    "group": "5",
    "timezone_name": "Europe/Belgrade",
    "timezone_info": {
      "timezone_id": "314",
      "name": "Europe/Belgrade",
      "name_formatted": "(UTC +01:00) Europe/Belgrade",
      "offset": "+2:00",
      "seconds": 7200,
      "hours": 2,
      "default": "0",
      "minutes": 0
    },
    "group_name": "Employee",
    "status_name": "Activated",
    "schedules": {
      "1324361": "Customer service"
    },
    "skills": {
      "96398": "sales",
      "96402": "tea"
    }
  },
  "token": "xxxxxxx"
}

Path Params

id
int32
required

Query Params

eid
string
log_data
string
status
string

enum [0, 1, -1, deleted, all] -1 Disabled, 0 Not activated, 1 Activated, deleted: Returns only deleted

 

Returns employee info.

Suggest Edits

POST Employee

/employees
Permission level: 4

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/employees
fname=Michael
lname=Stanley
nick_name=Mike
email=michael.stanley.333@mail.com
status=1
group=5
city=Dallas
state=Texas
gender=M
notes=Has CCNP certificate
custom={"27043":"Value for the custom field with ID 27043","30065":"Value for the custom field with ID 30065"}
https://www.humanity.com/api/v2/employees?access_token=xxxxxxxxxxxxxxxxxxxxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": "3997029",
        "username": "mikestan",
        "tusername": "",
        "email": "michael.stanley.333@mail.com",
        "title": null,
        "realname": "Mike",
        "url": null,
        "jabber": null,
        "icq": null,
        "msn": null,
        "aim": null,
        "yahoo": null,
        "location": "0",
        "signature": null,
        "disp_topics": null,
        "disp_posts": null,
        "email_setting": "1",
        "notify_with_post": "0",
        "auto_notify": "0",
        "show_smilies": "1",
        "show_img": "1",
        "show_img_sig": "1",
        "show_avatars": "1",
        "show_sig": "1",
        "access_keys": "0",
        "timezone": "314",
        "dst": "0",
        "time_format": "0",
        "date_format": "0",
        "language": null,
        "style": "ShiftPlanning",
        "num_posts": "0",
        "last_post": null,
        "last_search": null,
        "last_email_sent": null,
        "registered": "1523636283",
        "registration_ip": "82.117.214.54",
        "last_visit": "0",
        "last_active": "0",
        "admin_note": null,
        "activate_string": null,
        "activate_key": null,
        "pun_bbcode_enabled": "1",
        "pun_bbcode_use_buttons": "1",
        "pun_pm_new_messages": null,
        "pun_pm_long_subject": "1",
        "newsletter": "1",
        "email_confirmed": "0",
        "eid": null,
        "status": "1",
        "deleted": "0",
        "deleted_by": "0",
        "legal_agree": "0",
        "referral": "0",
        "wage": null,
        "name": "Mike",
        "firstname": "Michael",
        "lastname": "Stanley",
        "nick_name": "Mike",
        "birth_day": "0",
        "birth_month": "0",
        "smsgateway": null,
        "cell_phone": null,
        "cellphone_confirmed": "0",
        "last_sms_sent": "0",
        "home_phone": null,
        "avatar": {
            "small": "https://d3l54fgzztlejs.cloudfront.net/app/layout/images/no_avatar.png",
            "medium": "https://d3l54fgzztlejs.cloudfront.net/app/layout/images/no_avatar.png",
            "large": "https://d3l54fgzztlejs.cloudfront.net/app/layout/images/no_avatar.png"
        },
        "address": null,
        "city": "Dallas",
        "state": "Texas",
        "zip": null,
        "notes": "Has CCNP certificate",
        "p_email": "1",
        "p_phone": "1",
        "notify_sms": "-1",
        "notify_email": "1",
        "e_new_pm": "0",
        "ical": "https://www.humanity.com/ical/151addef5d61ac3a09aa1b0e78c0bb47.ics",
        "24hr": "0",
        "startday": "1",
        "pref_caltime": "10",
        "pref_shift_autoconfirm": "-1",
        "undertime": "0",
        "overtime": "-1",
        "recommend": "0",
        "recommendation": "",
        "tut_v2_sched": "0",
        "daily_overtime": "0",
        "max_days_row": "-1",
        "pref_vacation_max_days": "-1",
        "timezone_id": null,
        "monthly_undertime": "0",
        "monthly_overtime": "-1",
        "pref_mtimebshifts": "0",
        "avatar_url": null,
        "deactivated": "0",
        "work_start_date": "2018-04-13 18:18:03",
        "screen_logger": "0",
        "sc_freq": "-2",
        "newsletter_receiver": "0",
        "job_title": null,
        "middle_name": null,
        "gender": "M",
        "pref_sp_skin": "1",
        "inline_wizard_completion": null,
        "teamtools_id": "0",
        "updated_at": "2018-04-13 18:18:03",
        "unique_id": null,
        "employee_type": "0",
        "pay_type": "0",
        "group": "5",
        "timezone_name": "Europe/Belgrade",
        "group_name": "Employee",
        "status_name": "Activated",
        "schedules": [],
        "skills": [],
        "custom": {
            "26768": {
                "id": "26768",
                "name": "PTO balance [hours]",
                "type": "1",
                "access": "1",
                "values": "",
                "value": null,
                "text": null,
                "toggle": null
            },
            "27043": {
                "id": "27043",
                "name": "CF2",
                "type": "1",
                "access": "1",
                "values": "",
                "value": "Value for the custom field with ID 27043",
                "text": "",
                "toggle": "0"
            },
            "27044": {
                "id": "27044",
                "name": "Checkbox CF",
                "type": "4",
                "access": "1",
                "values": "",
                "value": null,
                "text": null,
                "toggle": null
            }
        },
        "settings": {
            "widgets_layout": [
                [
                    "timeclock",
                    "training",
                    "files",
                    "upcomingshifts",
                    "anniversary",
                    "notices"
                ],
                [
                    "onnow",
                    "leaves",
                    "lateforwork",
                    "birthdays"
                ],
                [
                    "messagewall"
                ]
            ],
            "schedule_side_panel_visibility": 1,
            "linked_shift_time": 1,
            "schedule_view_selected": "week",
            "schedule_timeline_selected": "employee",
            "schedule_budget_mode_visibility": 0,
            "schedule_forecast_graph_visibility": 0,
            "schedule_copy_rules_choice": 0,
            "shift_skill_filter_visibility": 0,
            "shift_task_assignment_visibility": 0,
            "default_location_panel_visibility": 0,
            "include_ghost_shifts": 0,
            "is_first_schedule_visit": 0
        }
    },
    "token": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "error": null
}

Form Data

eid
string
status
string

enum [0, 1, -1, -2] -> -1: Disabled; 0: Deactivated; 1: Activated

group
string

enum [2, 3, 4, 5, 6, 7] -> 2: Manager; 3: Supervisor; 4: Scheduler; 5: Employee; 6: Accountant; 7: Schedule Viewer

email
string
nick_name
string
birth_day
int32
birth_month
int32
cell_phone
string
wage
int32
home_phone
string
address
string
city
string
state
string
job_title
string
middle_name
string
gender
string

enum['M','F']

zip
string
notes
string
smsgateway
int32
password
string

Minimum 6 characters.

username
string

Minimum 3 characters.

send_activation
int32

enum [1] -> 1: Send activation

facebook
string
google
string
ldap
string
language
string
skills
string

Comma-separated array of skill IDs

timezone_id
int32
location
int32
undertime
int32
overtime
int32
daily_overtime
int32
max_days_row
int32
pref_shift_autoconfirm
int32

enum [-1, 1, -2]

pref_vacation_max_days
int32
custom
json

A JSON string representing an object with multiple key-value pairs. Key should contain the Custom Field ID, and value the Custom Field content.

positions
json

An array of position IDs in JSON format, eg. [747311, 743314]

monthly_overtime
int32
monthly_undertime
int32
pref_mtimebshifts
int32

enum [0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48]

work_start_date
date
fname
string
lname
string
name
string
 

Creates new employee.

Suggest Edits

PUT Employee

/employees/:id
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/employees/id
id=3997029
custom={"27043":"New value for the custom field with ID 27043","30065":"New value for the custom field with ID 30065"}
addskill=82458
addschedule=1819357
https://www.humanity.com/api/v2/employees/2744274?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": "3997029",
        "username": "mikestan",
        "tusername": "",
        "email": "michael.stanley.333@mail.com",
        "title": null,
        "realname": "Mike",
        "url": null,
        "jabber": null,
        "icq": null,
        "msn": null,
        "aim": null,
        "yahoo": null,
        "location": "0",
        "signature": null,
        "disp_topics": null,
        "disp_posts": null,
        "email_setting": "1",
        "notify_with_post": "0",
        "auto_notify": "0",
        "show_smilies": "1",
        "show_img": "1",
        "show_img_sig": "1",
        "show_avatars": "1",
        "show_sig": "1",
        "access_keys": "0",
        "timezone": "314",
        "dst": "0",
        "time_format": "0",
        "date_format": "0",
        "language": null,
        "style": "ShiftPlanning",
        "num_posts": "0",
        "last_post": null,
        "last_search": null,
        "last_email_sent": null,
        "registered": "1523636522",
        "registration_ip": "82.117.214.54",
        "last_visit": "0",
        "last_active": "0",
        "admin_note": null,
        "activate_string": null,
        "activate_key": null,
        "pun_bbcode_enabled": "1",
        "pun_bbcode_use_buttons": "1",
        "pun_pm_new_messages": null,
        "pun_pm_long_subject": "1",
        "newsletter": "1",
        "email_confirmed": "0",
        "eid": null,
        "status": "1",
        "deleted": "0",
        "deleted_by": "0",
        "legal_agree": "0",
        "referral": "0",
        "wage": null,
        "name": "Mike",
        "firstname": "Michael",
        "lastname": "Stanley",
        "nick_name": "Mike",
        "birth_day": "0",
        "birth_month": "0",
        "smsgateway": null,
        "cell_phone": null,
        "cellphone_confirmed": "0",
        "last_sms_sent": "0",
        "home_phone": null,
        "avatar": {
            "small": "https://d3l54fgzztlejs.cloudfront.net/app/layout/images/no_avatar.png",
            "medium": "https://d3l54fgzztlejs.cloudfront.net/app/layout/images/no_avatar.png",
            "large": "https://d3l54fgzztlejs.cloudfront.net/app/layout/images/no_avatar.png"
        },
        "address": null,
        "city": "Dallas",
        "state": "Texas",
        "zip": null,
        "notes": "Has CCNP certificate",
        "p_email": "1",
        "p_phone": "1",
        "notify_sms": "-1",
        "notify_email": "1",
        "e_new_pm": "0",
        "ical": "https://www.humanity.com/ical/63003e011dcbce011aa0d9d426017f3b.ics",
        "24hr": "0",
        "startday": "1",
        "pref_caltime": "10",
        "pref_shift_autoconfirm": "-1",
        "undertime": "0",
        "overtime": "-1",
        "recommend": "0",
        "recommendation": "",
        "tut_v2_sched": "0",
        "daily_overtime": "0",
        "max_days_row": "-1",
        "pref_vacation_max_days": "-1",
        "timezone_id": null,
        "monthly_undertime": "0",
        "monthly_overtime": "-1",
        "pref_mtimebshifts": "0",
        "avatar_url": null,
        "deactivated": "0",
        "work_start_date": "2018-04-13 18:22:02",
        "screen_logger": "0",
        "sc_freq": "-2",
        "newsletter_receiver": "0",
        "job_title": null,
        "middle_name": null,
        "gender": "M",
        "pref_sp_skin": "1",
        "inline_wizard_completion": null,
        "teamtools_id": "0",
        "updated_at": "2018-04-13 18:47:48",
        "unique_id": null,
        "employee_type": "0",
        "pay_type": "0",
        "group": "5",
        "timezone_name": "Europe/Belgrade",
        "group_name": "Employee",
        "status_name": "Activated",
        "schedules": {
            "1819357": "New funky job"
        },
        "skills": {
            "82458": "Oracle certified"
        },
        "custom": {
            "26768": {
                "id": "26768",
                "name": "PTO balance [hours]",
                "type": "1",
                "access": "1",
                "values": "",
                "value": null,
                "text": null,
                "toggle": null
            },
            "27043": {
                "id": "27043",
                "name": "CF2",
                "type": "1",
                "access": "1",
                "values": "",
                "value": "New value for the custom field with ID 27043",
                "text": "",
                "toggle": "0"
            },
            "27044": {
                "id": "27044",
                "name": "Checkbox CF",
                "type": "4",
                "access": "1",
                "values": "",
                "value": null,
                "text": null,
                "toggle": null
            }
        },
        "settings": {
            "widgets_layout": [
                [
                    "timeclock",
                    "training",
                    "files",
                    "upcomingshifts",
                    "anniversary",
                    "notices"
                ],
                [
                    "onnow",
                    "leaves",
                    "lateforwork",
                    "birthdays"
                ],
                [
                    "messagewall"
                ]
            ],
            "schedule_side_panel_visibility": 1,
            "linked_shift_time": 1,
            "schedule_view_selected": "week",
            "schedule_timeline_selected": "employee",
            "schedule_budget_mode_visibility": 0,
            "schedule_forecast_graph_visibility": 0,
            "schedule_copy_rules_choice": 0,
            "shift_skill_filter_visibility": 0,
            "shift_task_assignment_visibility": 0,
            "default_location_panel_visibility": 0,
            "include_ghost_shifts": 0,
            "is_first_schedule_visit": 0
        }
    },
    "token": "xxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "error": null
}

Path Params

id
int32
required

Form Data

job_title
string
notes
string
eid
string
first_name
string
group
string

enum [2, 3, 4, 5, 6, 7] -> 2: Manager; 3: Supervisor; 4: Scheduler; 5: Employee; 6: Accountant; 7: Schedule Viewer

status
string

enum [0, 1, -1, -2] -> -1: Disabled; 0: Deactivated; 1: Activated

name
string
last_name
string
nick_name
string
email
string
wage
int32
cell_phone
string
birth_day
int32
birth_month
int32
p_email
int32

enum [0, 1]

p_phone
int32

enum [0, 1]

state
string
address
string
home_phone
string
city
string
zip
string
gender
string

enum['M','F']

middle_name
string
max_days_row
int32
custom
string

A JSON string representing an object with multiple key-value pairs. Key should contain the Custom Field ID, and value the Custom Field content.

language
string
removeschedule
string
smsgateway
int32
password
string

Minimum 6 characters.

addskill
int32

Skill ID

addschedule
int32

Position ID

username
string

Minimum 3 characters.

removeskill
int32
send_activation
int32

enum [1] -> 1: Send activation

undertime
int32
timezone_id
int32
location
int32
pref_shift_autoconfirm
int32

enum [-1, 1, -2]

pref_vacation_max_days
int32
daily_overtime
int32
overtime
int32
monthly_overtime
int32
monthly_undertime
int32
pref_mtimebshifts
int32

enum [0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48]

work_start_date
date
pref_sp_skin
string

enum [0, 1, 2] -> 0: ShiftPlanning; 1: Humanity; 2: Humanity permanent

 

Updates employees account.

Suggest Edits

DELETE Employee

/employees/:id
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://www.humanity.com/api/v2/employees/id
https://www.humanity.com/api/v2/employees/2744282?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": "User Deleted",
  "token": "xxxxxxx"
}

Path Params

id
int32
required
 

Deletes employees account.

Suggest Edits

GET Employee positions

/employees/:employee_id/positions
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/employees/employee_id/positions
https://www.humanity.com/api/v2/employees/2/positions?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": [
    {
      "id": 234209,
      "employee_id": 2,
      "position_id": 862,
      "created_by": 2,
      "date": 1315921879,
      "payroll_ratecard_id": null,
      "payroll_wage": null
    },
    {
      "id": 234211,
      "employee_id": 2,
      "position_id": 863,
      "created_by": 2,
      "date": 1315921879,
      "payroll_ratecard_id": null,
      "payroll_wage": null
    },
    {
      "id": 234208,
      "employee_id": 2,
      "position_id": 46506,
      "created_by": 2,
      "date": 1315921879,
      "payroll_ratecard_id": null,
      "payroll_wage": null
    }  
  ],
  "error": null
}

Path Params

employee_id
int32
required
 

Return positions assigned to employee

Suggest Edits

GET Employee position

/employees/:employee_id/positions/:position_id
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/employees/employee_id/positions/position_id
https://www.humanity.com/api/v2/employees/2/positions/862?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 234209,
    "employee_id": 2,
    "position_id": 862,
    "created_by": 2,
    "date": 1315921879,
    "payroll_ratecard_id": null,
    "payroll_wage": null
  },
  "error": null
}

Path Params

employee_id
int32
required
position_id
int32
required
 

Return information about specified position which is assigned to specified employee id

Suggest Edits

POST Employee position

/employees/:employee_id/positions/:position_id
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/employees/employee_id/positions/position_id
https://www.humanity.com/api/v2/employees/2874406/positions/862?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 36866536,
    "employee_id": 2874406,
    "position_id": 862,
    "created_by": 2,
    "date": 1485356451,
    "payroll_ratecard_id": null,
    "payroll_wage": null
  },
  "error": null
}

Path Params

employee_id
int32
required
position_id
int32
required

Form Data

payroll_ratecard_id
int32
payroll_wage
string
 

Assigns position to employee

Suggest Edits

PUT Employee position

/employees/:employee_id/positions/:position_id
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/employees/employee_id/positions/position_id
https://www.humanity.com/api/v2/employees/2874406/positions/862?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 36866536,
    "employee_id": 2874406,
    "position_id": 862,
    "created_by": 2,
    "date": 1485356451,
    "payroll_ratecard_id": null,
    "payroll_wage": null
  },
  "error": null
}

Path Params

employee_id
int32
required
position_id
int32
required

Form Data

payroll_ratecard_id
int32
payroll_wage
string
 

Update employee position

Suggest Edits

DELETE Employee position

/employees/:employee_id/positions/:position_id
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://www.humanity.com/api/v2/employees/employee_id/positions/position_id
https://www.humanity.com/api/v2/employees/2874406/positions/862?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 36866536,
    "employee_id": 2874406,
    "position_id": 862,
    "created_by": 2,
    "date": 1485356451,
    "payroll_ratecard_id": 0,
    "payroll_wage": null
  },
  "error": null
}

Path Params

employee_id
int32
required
position_id
int32
required
 

Delete employee position

Suggest Edits

GET Timeclocks

/timeclocks
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/timeclocks
https://www.humanity.com/api/v2/timeclocks?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": [
    {
      "id": "46504175",
      "store": "251300",
      "status": "0",
      "schedule": {
        "id": "1321635",
        "name": "Waiter"
      },
      "notes": null,
      "created": "1470143318",
      "in_timestamp": "1470110700",
      "in_day": "2652",
      "out_timestamp": "1470141120",
      "out_day": "2652",
      "in_hour": "25",
      "out_hour": "59",
      "in_location": "Website",
      "out_location": "Website",
      "in_terminal": "0",
      "out_terminal": "-98",
      "approved_by": "0",
      "approved_time": "0",
      "approved_notes": "",
      "in_picture": null,
      "out_picture": "",
      "screenshots": null,
      "break_time": "0",
      "start_timestamp": "2016-08-02 06:05:00",
      "end_timestamp": "2016-08-02 14:32:00",
      "in_picture_url": null,
      "out_picture_url": null,
      "in_gps": null,
      "out_gps": null,
      "shift": null,
      "employee": {
        "id": "2736727",
        "name": "Brian Lane"
      },
      "in_time": {
        "time": "6:05am",
        "day": "Aug 2, 2016",
        "timestamp": "2016-08-02 06:05:00"
      },
      "length": {
        "hours": 8,
        "mins": 27,
        "total_hours": "8.45"
      },
      "out_time": {
        "time": "2:32pm",
        "day": "Aug 2, 2016",
        "timestamp": "2016-08-02 14:32:00"
      },
      "current_length": {
        "hours": 9,
        "mins": 41,
        "total_hours": "9.69"
      },
      "events": [
        {
          "id": "63256051",
          "type": "6",
          "timestamp": "2016-08-02 06:05:00",
          "clock_time": "46504175",
          "data": {
            "position": "1321635"
          }
        }
      ]
    },
    {
      "id": "46489414",
      "store": "251300",
      "status": "0",
      "schedule": {
        "id": "1321634",
        "name": "Manager"
      },
      "notes": null,
      "created": "1470132429",
      "in_timestamp": "1470132429",
      "in_day": "2652",
      "out_timestamp": "1470138961",
      "out_day": "2652",
      "in_hour": "49",
      "out_hour": "57",
      "in_location": "82.117.214.54",
      "out_location": "82.117.214.54",
      "in_terminal": "0",
      "out_terminal": "-98",
      "approved_by": "0",
      "approved_time": "0",
      "approved_notes": "",
      "in_picture": null,
      "out_picture": "",
      "screenshots": null,
      "break_time": "0",
      "start_timestamp": "2016-08-02 12:07:09",
      "end_timestamp": "2016-08-02 13:56:01",
      "in_picture_url": "",
      "out_picture_url": "",
      "in_gps": "{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
      "out_gps": "{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
      "shift": null,
      "employee": {
        "id": "2736727",
        "name": "Brian Lane"
      },
      "in_time": {
        "time": "12:07pm",
        "day": "Aug 2, 2016",
        "timestamp": "2016-08-02 12:07:09"
      },
      "length": {
        "hours": 1,
        "mins": 49,
        "total_hours": "1.81"
      },
      "out_time": {
        "time": "1:56pm",
        "day": "Aug 2, 2016",
        "timestamp": "2016-08-02 13:56:01"
      },
      "current_length": {
        "hours": 3,
        "mins": 39,
        "total_hours": "3.65"
      },
      "events": [
        {
          "id": "63239681",
          "type": "6",
          "timestamp": "2016-08-02 12:07:10",
          "clock_time": "46489414",
          "data": {
            "position": "1321634"
          }
        }
      ]
    },
    {
      "id": "46504116",
      "store": "251300",
      "status": "0",
      "schedule": {
        "id": "1321636",
        "name": "Desk Service"
      },
      "notes": null,
      "created": "1470143288",
      "in_timestamp": "1470121200",
      "in_day": "2652",
      "out_timestamp": "1470135600",
      "out_day": "2652",
      "in_hour": "37",
      "out_hour": "53",
      "in_location": "Website",
      "out_location": "Website",
      "in_terminal": "0",
      "out_terminal": "-98",
      "approved_by": "0",
      "approved_time": "0",
      "approved_notes": "",
      "in_picture": null,
      "out_picture": "",
      "screenshots": null,
      "break_time": "0",
      "start_timestamp": "2016-08-02 09:00:00",
      "end_timestamp": "2016-08-02 13:00:00",
      "in_picture_url": null,
      "out_picture_url": null,
      "in_gps": null,
      "out_gps": null,
      "shift": "314238628",
      "employee": {
        "id": "2744092",
        "name": "Derrick Arnold"
      },
      "in_time": {
        "time": "9:00am",
        "day": "Aug 2, 2016",
        "timestamp": "2016-08-02 09:00:00"
      },
      "length": {
        "hours": 4,
        "mins": 0,
        "total_hours": "4.00"
      },
      "out_time": {
        "time": "1:00pm",
        "day": "Aug 2, 2016",
        "timestamp": "2016-08-02 13:00:00"
      },
      "current_length": {
        "hours": 6,
        "mins": 46,
        "total_hours": "6.77"
      },
      "events": [
        {
          "id": "63255989",
          "type": "6",
          "timestamp": "2016-08-02 09:00:00",
          "clock_time": "46504116",
          "data": {
            "position": "1321636"
          }
        },
        {
          "id": "63255990",
          "type": "4",
          "timestamp": "2016-08-02 09:00:00",
          "clock_time": "46504116",
          "data": {
            "location": "542312"
          }
        }
      ]
    },
    {
      "id": "46504479",
      "store": "251300",
      "status": "0",
      "schedule": {
        "id": "1324358",
        "name": "Barista"
      },
      "notes": "I was working overtime.",
      "created": "1470143512",
      "in_timestamp": "1470027180",
      "in_day": "2651",
      "out_timestamp": "1470065220",
      "out_day": "2651",
      "in_hour": "29",
      "out_hour": "71",
      "in_location": "Website",
      "out_location": "Website",
      "in_terminal": "0",
      "out_terminal": "-98",
      "approved_by": "0",
      "approved_time": "0",
      "approved_notes": "",
      "in_picture": null,
      "out_picture": "",
      "screenshots": null,
      "break_time": "0",
      "start_timestamp": "2016-08-01 06:53:00",
      "end_timestamp": "2016-08-01 17:27:00",
      "in_picture_url": null,
      "out_picture_url": null,
      "in_gps": null,
      "out_gps": null,
      "shift": null,
      "employee": {
        "id": "2744095",
        "name": "Kian Simonette"
      },
      "in_time": {
        "time": "6:53am",
        "day": "Aug 1, 2016",
        "timestamp": "2016-08-01 06:53:00"
      },
      "length": {
        "hours": 10,
        "mins": 34,
        "total_hours": "10.57"
      },
      "out_time": {
        "time": "5:27pm",
        "day": "Aug 1, 2016",
        "timestamp": "2016-08-01 17:27:00"
      },
      "current_length": {
        "hours": 32,
        "mins": 53,
        "total_hours": "32.89"
      },
      "events": [
        {
          "id": "63256408",
          "type": "3",
          "timestamp": "2016-08-01 06:53:00",
          "clock_time": "46504479",
          "data": {
            "notes": "I was working overtime."
          }
        },
        {
          "id": "63256409",
          "type": "6",
          "timestamp": "2016-08-01 06:53:00",
          "clock_time": "46504479",
          "data": {
            "position": "1324358"
          }
        }
      ]
    },
    {
      "id": "46504362",
      "store": "251300",
      "status": "0",
      "schedule": {
        "id": "1324361",
        "name": "Customer service"
      },
      "notes": null,
      "created": "1470143432",
      "in_timestamp": "1470030480",
      "in_day": "2651",
      "out_timestamp": "1470057540",
      "out_day": "2651",
      "in_hour": "32",
      "out_hour": "62",
      "in_location": "Website",
      "out_location": "Website",
      "in_terminal": "0",
      "out_terminal": "-98",
      "approved_by": "0",
      "approved_time": "0",
      "approved_notes": "",
      "in_picture": null,
      "out_picture": "",
      "screenshots": null,
      "break_time": "0",
      "start_timestamp": "2016-08-01 07:48:00",
      "end_timestamp": "2016-08-01 15:19:00",
      "in_picture_url": null,
      "out_picture_url": null,
      "in_gps": null,
      "out_gps": null,
      "shift": null,
      "employee": {
        "id": "2744094",
        "name": "Josephine P. Watson"
      },
      "in_time": {
        "time": "7:48am",
        "day": "Aug 1, 2016",
        "timestamp": "2016-08-01 07:48:00"
      },
      "length": {
        "hours": 7,
        "mins": 31,
        "total_hours": "7.52"
      },
      "out_time": {
        "time": "3:19pm",
        "day": "Aug 1, 2016",
        "timestamp": "2016-08-01 15:19:00"
      },
      "current_length": {
        "hours": 31,
        "mins": 58,
        "total_hours": "31.97"
      },
      "events": [
        {
          "id": "63256275",
          "type": "6",
          "timestamp": "2016-08-01 07:48:00",
          "clock_time": "46504362",
          "data": {
            "position": "1324361"
          }
        }
      ]
    },
    {
      "id": "46504240",
      "store": "251300",
      "status": "0",
      "schedule": {
        "id": "1324361",
        "name": "Customer service"
      },
      "notes": "I'm leaving earlier today.",
      "created": "1470143357",
      "in_timestamp": "1470128400",
      "in_day": "2652",
      "out_timestamp": "0",
      "out_day": "0",
      "in_hour": "45",
      "out_hour": "0",
      "in_location": "Website",
      "out_location": "Website",
      "in_terminal": "0",
      "out_terminal": "-98",
      "approved_by": "0",
      "approved_time": "0",
      "approved_notes": "",
      "in_picture": null,
      "out_picture": "",
      "screenshots": null,
      "break_time": "0",
      "start_timestamp": "2016-08-02 11:00:00",
      "end_timestamp": null,
      "in_picture_url": null,
      "out_picture_url": null,
      "in_gps": null,
      "out_gps": null,
      "shift": "314238427",
      "employee": {
        "id": "2744097",
        "name": "Sheri Downer"
      },
      "in_time": {
        "time": "11:00am",
        "day": "Aug 2, 2016",
        "timestamp": "2016-08-02 11:00:00"
      },
      "length": [],
      "out_time": [],
      "current_length": {
        "hours": 4,
        "mins": 46,
        "total_hours": "4.77"
      },
      "events": [
        {
          "id": "63256130",
          "type": "3",
          "timestamp": "2016-08-02 11:00:00",
          "clock_time": "46504240",
          "data": {
            "notes": "I'm leaving earlier today."
          }
        },
        {
          "id": "63256131",
          "type": "6",
          "timestamp": "2016-08-02 11:00:00",
          "clock_time": "46504240",
          "data": {
            "position": "1324361"
          }
        }
      ]
    },
    {
      "id": "46504278",
      "store": "251300",
      "status": "0",
      "schedule": {
        "id": "1324358",
        "name": "Barista"
      },
      "notes": null,
      "created": "1470143378",
      "in_timestamp": "1470118380",
      "in_day": "2652",
      "out_timestamp": "0",
      "out_day": "0",
      "in_hour": "34",
      "out_hour": "0",
      "in_location": "Website",
      "out_location": "Website",
      "in_terminal": "0",
      "out_terminal": "-98",
      "approved_by": "0",
      "approved_time": "0",
      "approved_notes": "",
      "in_picture": null,
      "out_picture": "",
      "screenshots": null,
      "break_time": "0",
      "start_timestamp": "2016-08-02 08:13:00",
      "end_timestamp": null,
      "in_picture_url": null,
      "out_picture_url": null,
      "in_gps": null,
      "out_gps": null,
      "shift": null,
      "employee": {
        "id": "2744098",
        "name": "Timothy Edison"
      },
      "in_time": {
        "time": "8:13am",
        "day": "Aug 2, 2016",
        "timestamp": "2016-08-02 08:13:00"
      },
      "length": [],
      "out_time": [],
      "current_length": {
        "hours": 7,
        "mins": 33,
        "total_hours": "7.56"
      },
      "events": [
        {
          "id": "63256180",
          "type": "6",
          "timestamp": "2016-08-02 08:13:00",
          "clock_time": "46504278",
          "data": {
            "position": "1324358"
          }
        }
      ]
    },
    {
      "id": "46504070",
      "store": "251300",
      "status": "0",
      "schedule": {
        "id": "1321634",
        "name": "Manager"
      },
      "notes": null,
      "created": "1470143263",
      "in_timestamp": "1470143263",
      "in_day": "2652",
      "out_timestamp": "0",
      "out_day": "0",
      "in_hour": "61",
      "out_hour": "0",
      "in_location": "82.117.214.54",
      "out_location": "Website",
      "in_terminal": "0",
      "out_terminal": "-98",
      "approved_by": "0",
      "approved_time": "0",
      "approved_notes": "",
      "in_picture": null,
      "out_picture": "",
      "screenshots": null,
      "break_time": "0",
      "start_timestamp": "2016-08-02 15:07:43",
      "end_timestamp": null,
      "in_picture_url": "",
      "out_picture_url": null,
      "in_gps": "{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
      "out_gps": null,
      "shift": "314237801",
      "employee": {
        "id": "2736727",
        "name": "Brian Lane"
      },
      "in_time": {
        "time": "3:07pm",
        "day": "Aug 2, 2016",
        "timestamp": "2016-08-02 15:07:43"
      },
      "length": [],
      "out_time": [],
      "current_length": {
        "hours": 0,
        "mins": 39,
        "total_hours": "0.64"
      },
      "events": [
        {
          "id": "63255945",
          "type": "6",
          "timestamp": "2016-08-02 15:07:43",
          "clock_time": "46504070",
          "data": {
            "position": "1321634"
          }
        }
      ]
    }
  ],
  "token": "xxxxxxx"
}

Query Params

start_date
date
end_date
date
schedule
int32
employee
int32
status
string

[approved, unapproved]

page
int32
per_page
int32
order_by
string

[id, end_timestamp]

direction
string

[asc, desc]

 

Returns a list of all timeclocks.

Suggest Edits

GET Timeclock

/timeclocks/:id
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/timeclocks/id
https://www.humanity.com/api/v2/timeclocks/46504479?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": "46504479",
    "store": "251300",
    "status": "0",
    "schedule": {
      "id": "1324358",
      "name": "Barista"
    },
    "notes": "I was working overtime.",
    "created": "1470143512",
    "in_timestamp": "1470027180",
    "in_day": "2651",
    "out_timestamp": "1470065220",
    "out_day": "2651",
    "in_hour": "29",
    "out_hour": "71",
    "in_location": "Website",
    "out_location": "Website",
    "in_terminal": "0",
    "out_terminal": "-98",
    "approved_by": "0",
    "approved_time": "0",
    "approved_notes": "",
    "in_picture": null,
    "out_picture": "",
    "screenshots": null,
    "break_time": "0",
    "start_timestamp": "2016-08-01 06:53:00",
    "end_timestamp": "2016-08-01 17:27:00",
    "in_picture_url": null,
    "out_picture_url": null,
    "in_gps": null,
    "out_gps": null,
    "shift": null,
    "employee": {
      "id": "2744095",
      "name": "Kian Simonette"
    },
    "in_time": {
      "time": "6:53am",
      "day": "Aug 1, 2016",
      "timestamp": "2016-08-01 06:53:00"
    },
    "length": {
      "hours": 10,
      "mins": 34,
      "total_hours": "10.57"
    },
    "out_time": {
      "time": "5:27pm",
      "day": "Aug 1, 2016",
      "timestamp": "2016-08-01 17:27:00"
    },
    "current_length": {
      "hours": 32,
      "mins": 55,
      "total_hours": "32.91"
    },
    "events": [
      {
        "id": "63256408",
        "type": "3",
        "timestamp": "2016-08-01 06:53:00",
        "clock_time": "46504479",
        "data": {
          "notes": "I was working overtime."
        }
      },
      {
        "id": "63256409",
        "type": "6",
        "timestamp": "2016-08-01 06:53:00",
        "clock_time": "46504479",
        "data": {
          "position": "1324358"
        }
      }
    ]
  },
  "token": "xxxxxxx"
  }
}

Path Params

id
int32
required
 

Retrieves an individual Clock Time.

Suggest Edits

GET Timeclock status

/timeclocks/status/:employee/:details
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/timeclocks/status/employee/details
https://www.humanity.com/api/v2/timeclocks/status/2736727/1?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": "49933530",
    "store": "251300",
    "status": "0",
    "schedule": null,
    "notes": null,
    "created": "1475237863",
    "in_timestamp": "1475237863",
    "in_day": "2711",
    "out_timestamp": "0",
    "out_day": "0",
    "in_hour": "58",
    "out_hour": "0",
    "in_location": "test IP",
    "out_location": "Website",
    "in_terminal": "0",
    "out_terminal": "-98",
    "approved_by": "0",
    "approved_time": "0",
    "approved_notes": "",
    "in_picture": null,
    "out_picture": "",
    "screenshots": null,
    "break_time": "0",
    "start_timestamp": "2016-09-30 14:17:43",
    "end_timestamp": null,
    "in_picture_url": "",
    "out_picture_url": null,
    "in_gps": "{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
    "out_gps": null,
    "shift": null,
    "employee": {
      "id": "2736727",
      "name": "Brian Lane"
    },
    "in_time": {
      "time": "2:17pm",
      "day": "Sep 30, 2016",
      "timestamp": "2016-09-30 14:17:43"
    },
    "length": [],
    "out_time": [],
    "current_length": {
      "hours": 0,
      "mins": 24,
      "total_hours": "0.40"
    },
    "events": []
  },
  "token": "xxxxxxx"
  }

Path Params

employee
int32
required
details
int32
required

enum[0, 1]

 

Get Clock Status of Employee (Default: Authenticated User). Returns 'in' or 'out'

Suggest Edits

POST Timeclock

/timeclocks
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/timeclocks
start_date=2016-08-01
end_date=2016-08-01
start_time=07:14:25
end_time=15:12:36
employee=2744095
schedule=1324358
https://www.humanity.com/api/v2/timeclocks?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": "46507879",
    "store": "251300",
    "status": "0",
    "schedule": {
      "id": "1324358",
      "name": "Barista"
    },
    "notes": null,
    "created": "1470145923",
    "in_timestamp": "1470028500",
    "in_day": "2651",
    "out_timestamp": "1470057300",
    "out_day": "2651",
    "in_hour": "30",
    "out_hour": "62",
    "in_location": "Mobile",
    "out_location": "Mobile",
    "in_terminal": "0",
    "out_terminal": "-98",
    "approved_by": "0",
    "approved_time": "0",
    "approved_notes": "",
    "in_picture": null,
    "out_picture": "",
    "screenshots": null,
    "break_time": "0",
    "start_timestamp": "2016-08-01 07:15:00",
    "end_timestamp": "2016-08-01 15:15:00",
    "in_picture_url": null,
    "out_picture_url": null,
    "in_gps": null,
    "out_gps": null,
    "shift": null,
    "employee": {
      "id": "2744095",
      "name": "Kian Simonette"
    },
    "in_time": {
      "time": "7:15am",
      "day": "Aug 1, 2016",
      "timestamp": "2016-08-01 07:15:00"
    },
    "length": {
      "hours": 8,
      "mins": 0,
      "total_hours": "8.00"
    },
    "out_time": {
      "time": "3:15pm",
      "day": "Aug 1, 2016",
      "timestamp": "2016-08-01 15:15:00"
    },
    "current_length": {
      "hours": 32,
      "mins": 37,
      "total_hours": "32.62"
    },
    "events": []
  },
  "token": "xxxxxxx"
}

Form Data

start_date
date
required
start_time
date
required
employee
int32
required
schedule
int32
end_date
date
end_time
date
notes
string
tips
string
 

Creates an individual timeclock.

Suggest Edits

PUT Timeclock

/timeclocks/:id
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/timeclocks/id
approved=1
notes=I approved this timeclock
https://www.humanity.com/api/v2/timeclocks/46504362?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": "46504362",
    "store": "251300",
    "status": "0",
    "schedule": {
      "id": "1324361",
      "name": "Customer service"
    },
    "notes": "I approved this timeclock",
    "created": "1470143432",
    "in_timestamp": "1470030480",
    "in_day": "2651",
    "out_timestamp": "1470057540",
    "out_day": "2651",
    "in_hour": "32",
    "out_hour": "62",
    "in_location": "Website",
    "out_location": "Website",
    "in_terminal": "0",
    "out_terminal": "-98",
    "approved_by": "2736727",
    "approved_time": "1470146295",
    "approved_notes": "",
    "in_picture": null,
    "out_picture": "",
    "screenshots": null,
    "break_time": "0",
    "start_timestamp": "2016-08-01 07:48:00",
    "end_timestamp": "2016-08-01 15:19:00",
    "in_picture_url": null,
    "out_picture_url": null,
    "in_gps": null,
    "out_gps": null,
    "shift": null,
    "employee": {
      "id": "2744094",
      "name": "Josephine P. Watson"
    },
    "in_time": {
      "time": "7:48am",
      "day": "Aug 1, 2016",
      "timestamp": "2016-08-01 07:48:00"
    },
    "length": {
      "hours": 7,
      "mins": 31,
      "total_hours": "7.52"
    },
    "out_time": {
      "time": "3:19pm",
      "day": "Aug 1, 2016",
      "timestamp": "2016-08-01 15:19:00"
    },
    "current_length": {
      "hours": 32,
      "mins": 10,
      "total_hours": "32.17"
    },
    "events": [
      {
        "id": "63256275",
        "type": "6",
        "timestamp": "2016-08-01 07:48:00",
        "clock_time": "46504362",
        "data": {
          "position": "1324361"
        }
      },
      {
        "id": "63261564",
        "type": "3",
        "timestamp": "2016-08-01 15:19:00",
        "clock_time": "46504362",
        "data": {
          "notes": "I approved this timeclock"
        }
      }
    ]
  },
  "token": "xxxxxxx"
}

Path Params

id
int32
required

Form Data

start_date
date
end_date
date
schedule
int32
employee
int32
start_time
date
end_time
date
notes
string
approved
int32

enum[0,1] -> 0: Unapproved; 1: Approved

tips
string
 

Updates an individual timeclock.

Suggest Edits

DELETE Timeclock

/timeclocks/:id
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://www.humanity.com/api/v2/timeclocks/id
https://www.humanity.com/api/v2/timeclocks/46504116?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": "",
  "token": "xxxxxxx"
}

Path Params

id
int32
required
 

Deletes an individual Clock Time.

Suggest Edits

POST Add clock time

/timeclock/addclocktime
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/timeclock/addclocktime
datein=2018-04-04 11:00:00
employee=3842510
onlyin=1
https://www.humanity.com/api/v2/timeclock/addclocktime?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": "Clock time added.",
    "token": "xxxxxxxxxx",
    "error": null
}

Form Data

datein
date
required
dateout
date
employee
int32
required
schedule
int32
notes
string
remote_site
int32

Remote site ID

tips
float
onlyin
string

Can be 0 or 1 - If set to 1 it will clock in

 

This is essentially the same endpoint as POST timeclock it just differs in response and the parameter datein accepts date and time unlike the POST timeclock where there are two separate parameters start date and start time

Suggest Edits

POST Save Note

/timeclock/savenote
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/timeclock/savenote
id=81868596
notes=I've missed my break today
https://www.humanity.com/api/v2/timeclock/savenote?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": "Notes Saved",
    "token": "xxxxxxxxx",
    "error": null
}

Form Data

id
int32
required

Time clock id

notes
string
 

Creates a note for the given time clock

Suggest Edits

PUT Manage time clock

/timeclock/manage
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/timeclock/manage
id=81868596
action=approve
https://www.humanity.com/api/v2/timeclock/manage?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": "Clock time approved.",
    "token": "xxxxxxxxxxxxx",
    "error": null
}

Form Data

id
int32
required

Time clock id

action
string
required

One of these parameters is allowed - ['approve', 'unapprove', 'reject', 'delete']

 

Manages individual time clock

Suggest Edits

PUT Force Clock Out

/timeclock/forceclockout
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/timeclock/forceclockout
id:81871373
https://www.humanity.com/api/v2/timeclock/forceclockout?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": "Clock out successfully!",
    "token": "194b812c58f993f261964182a02a7dac71cea6d2",
    "error": null
}

Form Data

id
int32
required

Time clock id

 

Forces a clock out

Suggest Edits

GET Timeclock event

/timeclocks/event/{timeclock}
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/timeclocks/event/timeclock
https://www.humanity.com/api/v2/timeclocks/event/70111593?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": [
        {
            "id": "99359463",
            "type": "3",
            "timestamp": "2017-09-04 07:45:00",
            "clock_time": "70111593",
            "data": {
                "notes": "Note 3a"
            }
        },
        {
            "id": "99359464",
            "type": "1",
            "timestamp": "2017-09-04 08:45:00",
            "clock_time": "70111593",
            "data": null
        },
        {
            "id": "99359465",
            "type": "2",
            "timestamp": "2017-09-04 08:52:00",
            "clock_time": "70111593",
            "data": {
                "breakin": 99359464
            }
        },
        {
            "id": "99359466",
            "type": "0",
            "timestamp": "2017-09-04 23:30:00",
            "clock_time": "70111593",
            "data": {
                "editreason": "Forgot to clockin on time and wanted to correct that."
            }
        }
    ],
    "token": "xxxxxxx",
    "error": null
}

Query Params

timeclock
int32
required

An ID of a timeclock for which we want to get all events.

 

Returns a list of all timeclock events for a timeclock which ID is provided as a value of the {timeclock} parameter (70111593 in this example)

Suggest Edits

POST Timeclock event

/timeclocks/event/{timeclock}
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/timeclocks/event/timeclock?access_token=xxxxxxx
type=breakin
https://www.humanity.com/api/v2/timeclocks/event/70551877?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "event": 100012192
    },
    "token": "e64b900c0dd53053ca974de411849eac8e09fd70",
    "error": null
}

Query Params

timeclock
int32
required

Time clock ID to which we want to add an event

Form Data

type
string
required

Accepted parameter value is of these constant strings: breakin, breakout, notes, location, position, tips

timestamp
date

Sets a custom date and time for this timeclock event. If not set, current time will be used. Should be in yyyy-MM-dd hh:mm:ss (24h) format.

notes
string

String variable holding a note. Used only with type=notes.

location
string

String containing an ID or a name of a Remote Site. An ID is usually sent. Used only with type=location.

position
string

String containing an ID or a name of a Position. An ID is usually sent. Used only with type=position.

tips
string

If a setting "Enable Timeclock Tips" is enabled, employees can enter their tip amounts with this parameter. Used only with type=tips.

 

Creates a new timeclock event for a timeclock which ID is provided as a {timeclock} query parameter (70111593 in this example). An ID of newly created timeclock event is returned in data.event field.

Suggest Edits

PUT Timeclock event

/timeclocks/event/{timeclock}
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/timeclocks/event/timeclock?access_token=xxxxxxx
type=events
data=[{"id":"100022881","type":"3","timestamp":"2017-09-11 09:27:00","clock_time":"70558246","data":{"notes":"Added note"},"time":"09:27","timeclock":"70558246"},{"id":"100022882","type":"6","timestamp":"2017-09-11 09:27:00","clock_time":"70558246","data":{"position":"743314"},"time":"09:27","timeclock":"70558246"},{"id":"100022883","type":"4","timestamp":"2017-09-11 09:27:00","clock_time":"70558246","data":{"location":"358844"},"time":"09:27","timeclock":"70558246"},{"id":"100023219","type":"1","timestamp":"2017-09-11 10:45:00","clock_time":"70558246","data":null,"time":"10:45","timeclock":"70558246"},{"id":"100023567","type":"2","timestamp":"2017-09-11 11:00:00","clock_time":"70558246","data":{"breakin":"100023219"},"time":"11:00","timeclock":"70558246"}]
clocktime={"timeclock":70558246,"tcin":"2017-09-11 09:27:00","tcout":"2017-09-11 20:11:00"}
https://www.humanity.com/api/v2/timeclocks/event/70551877?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "status": "Clock time updated.",
        "events": {
            "100022881": {
                "id": "100022881",
                "type": "3",
                "timestamp": "2017-09-11 09:27:00",
                "clock_time": "70558246",
                "data": {
                    "notes": "Added note"
                }
            },
            "100022882": {
                "id": "100022882",
                "type": "6",
                "timestamp": "2017-09-11 09:27:00",
                "clock_time": "70558246",
                "data": {
                    "position": 743314
                }
            },
            "100022883": {
                "id": "100022883",
                "type": "4",
                "timestamp": "2017-09-11 09:27:00",
                "clock_time": "70558246",
                "data": {
                    "location": 358844
                }
            },
            "100023219": {
                "id": "100023219",
                "type": "1",
                "timestamp": "2017-09-11 10:45:00",
                "clock_time": "70558246",
                "data": null
            },
            "100023567": {
                "id": "100023567",
                "type": "2",
                "timestamp": "2017-09-11 11:00:00",
                "clock_time": "70558246",
                "data": {
                    "breakin": 100023219
                }
            }
        }
    },
    "token": "xxxxxxx",
    "error": null
}

Query Params

timeclock
int32
required

Time clock ID to which we want to add an event

Form Data

type
string
required

Accepted parameter value is of these constant strings: breakin, breakout, notes, location, position, gps, tips, events

timestamp
date

Sets a custom date and time for this timeclock event. If not set, current time will be used. Should be in yyyy-MM-dd hh:mm:ss (24h) format.

notes
string

String variable holding a note. Used only with type=notes.

location
string

String containing an ID or a name of a Remote Site. An ID is usually sent. Used only with type=location.

position
string

String containing an ID or a name of a Position. An ID is usually sent. Used only with type=position.

tips
string

If a setting "Enable Timeclock Tips" is enabled, employees can enter their tip amounts with this parameter. Used only with type=tips.

event
json

A JSON containing the data which is used when parameter type is one of the following: breakin, breakout, notes, location, position and tips.

data
json

A JSON containing the data which is used when parameter type = events.

gps
string
clocktime
json

A JSON containing all data about parent timeclock. Used only when parameter type = events.

 

Updates a timeclock event. Most frequently used type is "events" as with it you can update all timeclock events at once. Parameter "type" within "data" parameter determines which event you want to update.

"data.type" parameter
Corresponding event

0

Time clock edit reason

1

Break in

2

Break out

3

Notes

4

Location

6

Position

8

Tips

In this example, the note event is updated.

Suggest Edits

DELETE Timeclock event

/timeclocks/event/{timeclock}
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://www.humanity.com/api/v2/timeclocks/event/timeclock?access_token=xxxxxxx
https://www.humanity.com/api/v2/timeclocks/event/70558246?access_token=xxxxxxx
type=delete
event=breakin|breakout|notes
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "status": "Event removed."
    },
    "token": "xxxxxxx",
    "error": null
}

Query Params

timeclock
int32

A timeclock ID for which we want to delete all events

Form Data

type
string

Accepted parameter value is of these constant strings: delete, restore. Value "delete" is used for removing events from assigned time clock, and "restore" is used for restoring them if they are deleted.

event
string

A string containing a pipe ( | ) delimited list of events for removal or restoration..

 

Deletes or restores time clock events.

Suggest Edits

GET Timeclock location

/timeclocks/locations
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/timeclocks/locations
https://www.humanity.com/api/v2/timeclocks/locations?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": [
    {
      "id": "62038",
      "store": "251300",
      "user": "2736727",
      "name": "Humanity's PC",
      "description": "",
      "status": "1",
      "type": "1",
      "ip": "82.117.214.54"
    },
    {
      "id": "62039",
      "store": "251300",
      "user": "2736727",
      "name": "test IP",
      "description": "",
      "status": "1",
      "type": "2",
      "ip": "82.117.214.54"
    }
  ],
  "token": "xxxxxxx"
}
 

Returns all timeclock locations.

Suggest Edits

POST Timeclock location

/timeclocks/locations
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/timeclocks/locations
https://www.humanity.com/api/v2/timeclocks/locations?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": "Location added",
  "error": null
}

Form Data

name
string
required
type
int32

enum[1,2] 1: Computer, 2: IP address

ip
string
description
string
 

Create clock in/out location.

Suggest Edits

DELETE Timeclock location

/timeclocks/locations/:id
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://www.humanity.com/api/v2/timeclocks/locations/id
https://www.humanity.com/api/v2/timeclocks/locations/123?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": "Location removed",
  "error": null
}

Path Params

id
int32
required
 

Delete clock in/out location.

Suggest Edits

GET Timeclocks terminal

/timeclocks/terminal
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/timeclocks/terminal
https://www.humanity.com/api/v2/timeclocks/terminal?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": [
    {
      "id": "45221",
      "store": "251300",
      "location": "62038",
      "key": "34e4beb994c1a48c4511d2485d20a07f",
      "name": "Zepter Office",
      "pref_login": "1",
      "pref_userid": "0",
      "pref_username": "0",
      "pref_password": "1",
      "pref_userlist": "1",
      "pref_webcam": "0"
    },
    {
      "id": "45222",
      "store": "251300",
      "location": "62039",
      "key": "e48e4e338b8293cd6caceaea3d76b61e",
      "name": "IP based Terminal",
      "pref_login": "1",
      "pref_userid": "0",
      "pref_username": "0",
      "pref_password": "1",
      "pref_userlist": "1",
      "pref_webcam": "1"
    }
  ],
  "token": "xxxxxxx"
}
 

Clockin terminal management.

Suggest Edits

GET Timeclock terminal

/timeclocks/terminal/:id
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/timeclocks/terminal/id
https://www.humanity.com/api/v2/timeclocks/terminal/45221?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": "45221",
    "store": "251300",
    "location": "62038",
    "key": "34e4beb994c1a48c4511d2485d20a07f",
    "name": "Zepter Office",
    "pref_login": "1",
    "pref_userid": "0",
    "pref_username": "0",
    "pref_password": "1",
    "pref_userlist": "1",
    "pref_webcam": "0"
  },
  "token": "xxxxxxx"
}

Path Params

id
int32
required
 

Clockin terminal management.

Suggest Edits

POST Timeclock terminal

/timeclocks/terminal
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/timeclocks/terminal
name=3rd floor Terminal
location=542311
pref_webcam=1
pref_password=1
https://www.humanity.com/api/v2/timeclocks/terminal?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": {
    "id": 45223,
    "store": "251300",
    "location": "542311",
    "key": "5652ae58ef163d6aad308ccc56013bdf",
    "name": "3rd floor Terminal",
    "pref_login": null,
    "pref_userid": null,
    "pref_username": null,
    "pref_password": "1",
    "pref_userlist": null,
    "pref_webcam": "1"
  },
  "token": "xxxxxxx"
}

Form Data

name
string
required
location
int32
required
pref_userlist
int32

enum [1, 2] -> 1: Show employees as select box; 2: Show as Gallery; 3: Show employees as search box;

pref_login
int32

enum [0, 1] -> 1: Require Full Employee Login; 0: Not requires

pref_webcam
int32

enum [0, 1] -> 1: Require Webcam; 0: Does not require Webcam

pref_password
int32

enum [0, 1] -> 1: Require Password; 0: Does not require Password

 

Creates new time clock terminal.

Suggest Edits

PUT Timeclock terminal

/timeclocks/terminal/:id
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/timeclocks/terminal/id
https://www.humanity.com/api/v2/timeclocks/terminal/45224?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
int32
required
 

Updates a timeclock terminal url

Suggest Edits

DELETE Timeclock terminal

/timeclocks/terminal/:id
Permission level: 3

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://www.humanity.com/api/v2/timeclocks/terminal/id
https://www.humanity.com/api/v2/timeclocks/terminal/45224?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": "Terminal deleted",
  "token": "xxxxxxx"
}

Path Params

id
int32
required
 

Deletes a timeclock terminal.

Suggest Edits

POST Terminal clockin

/terminal/clockin/:terminal_key
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/terminal/clockin/terminal_key
https://www.humanity.com/api/v2/terminal/clockin/xxxxxxx?access_token=xxxxxxx
id=2744095
logout=1
ip=xxx.xxx.xx.x
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": "You are clocked in",
  "token": "xxxxxxx"
}

Path Params

terminal_key
string
required

Form Data

id
int32

Employee id

photo
string
logout
int32

enum [0, 1] 1: Logout, 0: Do not logout

computer_id
int32
ip
string
notes
string
tips
string
 

Terminal clockin management

Suggest Edits

POST Terminal login

/terminal/login/:terminal_key
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/terminal/login/terminal_key
https://www.humanity.com/api/v2/terminal/login/xxxxxxx?access_token=xxxxxxx
terminal_key=xxxxxxx
id=2744095
username=test	
password=123123
ip=xxx.xxx.xx.x
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": "2736727",
  "token": "xxxxxxx"
}

Path Params

terminal_key
string
required

Form Data

id
int32

Employee id

username
string
password
string
computer_id
int32
ip
string
 

Terminal login management

Suggest Edits

POST Terminal clockout

/terminal/clockout/:terminal_key
Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/terminal/clockout/terminal_key
https://www.humanity.com/api/v2/terminal/clockout/xxxxxxx?access_token=xxxxxxx
id=2744095
schedule=1321634
logout=1
ip=xxx.xxx.xx.x
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": "You are clocked out",
  "token": "xxxxxxx"
}

Path Params

terminal_key
string
required

Form Data

id
int32
photo
string
schedule
int32
logout
int32

enum [0,1] 1: Logout, 0: Do not logout

computer_id
int32
ip
string
notes
string
tips
string
 

Terminal clockout management

Suggest Edits

GET Forecast(Datatypes)

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/forecast/datatypes/?access_token=xxxxxxx
https://www.humanity.com/api/v2/forecast/datatypes/?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": [
        {
            "id": 28,
            "unique_id": "25",
            "company_id": 303579,
            "name": "Forecast - Test",
            "description": "how many customers per day visits our store",
            "rules": [
                {
                    "threshold": "0",
                    "need_number": "2",
                    "need_product": "1614960",
                    "source_number": "5"
                }
            ],
            "api_locked": "0",
            "created_by": "3475050",
            "updated_by": "3475050",
            "deleted_by": null,
            "created_at": "2017-09-12 12:35:11",
            "updated_at": "2017-09-12 12:38:12",
            "deleted_at": null
        },
        {
            "id": 29,
            "unique_id": "15",
            "company_id": 303579,
            "name": "Forecast - Test 2",
            "description": "Calls per hour",
            "rules": [
                {
                    "threshold": "1",
                    "need_number": "3",
                    "need_product": "1614962",
                    "source_number": "50"
                }
            ],
            "api_locked": "0",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-12 13:05:33",
            "updated_at": null,
            "deleted_at": null
        }
    ],
    "token": "xxxxxxx",
    "error": null
}
 

Returns a list of all forecast datatypes

Suggest Edits

GET Forecast(Datatype) by ID

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/forecast/datatypes/datatype_id?access_token=xxxxxxxx
https://www.humanity.com/api/v2/forecast/datatypes/32?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 32,
        "unique_id": "",
        "company_id": 303579,
        "name": "Forecast - Test 3",
        "description": "",
        "rules": [],
        "api_locked": "0",
        "created_by": "3475050",
        "updated_by": null,
        "deleted_by": null,
        "created_at": "2017-09-12 13:36:59",
        "updated_at": null,
        "deleted_at": null
    },
    "token": "xxxxxxx",
    "error": null
}

Query Params

datatype_id
int32

Datatype ID

 

Returns a list of specific datatype

Suggest Edits

GET Forecast(Datatype) by unique_id

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/forecast/datatype/unique_id/unique_id_uid?access_token=xxxxxxx
https://www.humanity.com/api/v2/forecast/datatype/unique_id/222?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 32,
        "unique_id": "222",
        "company_id": 303579,
        "name": "Forecast - Test 3",
        "description": "",
        "rules": [],
        "api_locked": "0",
        "created_by": "3475050",
        "updated_by": "3475050",
        "deleted_by": null,
        "created_at": "2017-09-12 13:36:59",
        "updated_at": "2017-09-13 09:40:28",
        "deleted_at": null
    },
    "token": "xxxxxxx",
    "error": null
}

Query Params

unique_id_uid
int32

Datatype unique id

 

Returns a list of specific datatype by unique ID

Suggest Edits

POST Forecast(Datatype)

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/forecast/datatypes?access_token=xxxxxxx
name=Forecast - Test 4
description=Calls per hour
unique_id=12345
rules=[{"source_number":"5","need_number":"2","need_product":"1614960","threshold":"0"}]
api_locked=0
https://www.humanity.com/api/v2/forecast/datatypes?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 43,
        "unique_id": "12345",
        "company_id": 303579,
        "name": "Forecast - Test 4",
        "description": "Calls per hour",
        "rules": [
            {
                "source_number": "5",
                "need_number": "2",
                "need_product": "1614960",
                "threshold": "0"
            }
        ],
        "api_locked": "0",
        "created_by": 3475050,
        "updated_by": null,
        "deleted_by": null,
        "created_at": "2017-09-12 14:20:24",
        "updated_at": null,
        "deleted_at": null
    },
    "token": "xxxxxxx",
    "error": null
}

Form Data

name
string
required

Sets the name of the Forecast/Datatype

description
string

Adds a description for this forecast/datatype

unique_id
int32

Sets the unique id of the forecast/datatype

rules
json

Sets the rules for this forecast/datatype

api_locked
int32

Can be only 0 or 1, if set to 1 datatype can not be changed or deleted from the application, only via API.

 

Create a new forecast/datatype with rules.

Suggest Edits

PUT Forecast(Datatypes) by id

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/forecast/datatypes/datatype_id?access_token=xxxxxx
https://www.humanity.com/api/v2/forecast/datatypes/29?access_token=xxxxxxx
name=Forcast - PUT
unique_id=555858
api_locked=0
rules=[{"source_number":"15","need_number":"5","need_product":"1614960","threshold":"2"}]
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 29,
        "unique_id": "555858",
        "company_id": 303579,
        "name": "Forcast - PUT",
        "description": "Calls per hour",
        "rules": [
            {
                "source_number": "15",
                "need_number": "5",
                "need_product": "1614960",
                "threshold": "2"
            }
        ],
        "api_locked": "0",
        "created_by": "3475050",
        "updated_by": 3475050,
        "deleted_by": null,
        "created_at": "2017-09-12 13:05:33",
        "updated_at": "2017-09-13 10:01:08",
        "deleted_at": null
    },
    "token": "xxxxxxx",
    "error": null
}

Query Params

datatype_id
int32

Datatype ID which we want to update

Form Data

name
string

Updates the name of datatype

unique_id
int32

Updates the unique_id

rules
json

Updates the rules

api_locked
int32

Updates the api_locked param that can be set to 1 or 0

 

Updates the datatype

Suggest Edits

PUT Forecast(Datatypes) by unique ID

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/forecast/datatype/unique_id/unique_id_uid?access_token=xxxxxxx
https://www.humanity.com/api/v2/forecast/datatype/unique_id/147?access_token=xxxxxxx
name=Forecast - TEST 17
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 32,
        "unique_id": "222",
        "company_id": 303579,
        "name": "Forecast - TEST 17",
        "description": "",
        "rules": [],
        "api_locked": "0",
        "created_by": "3475050",
        "updated_by": 3475050,
        "deleted_by": null,
        "created_at": "2017-09-12 13:36:59",
        "updated_at": "2017-09-24 20:05:44",
        "deleted_at": null
    },
    "token": "xxxxxx",
    "error": null
}

Query Params

unique_id_uid
int32

Datatype unique ID which we want to update

Form Data

name
string

Updates the name of datatype

 

Updates the datatype by unique_id

Suggest Edits

DELETE Forecast(Datatype)

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://www.humanity.com/api/v2/forecast/datatypes/datatype_id?access_token=xxxxxxx
https://www.humanity.com/api/v2/forecast/datatypes/43?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 43,
        "unique_id": "12345",
        "company_id": 303579,
        "name": "Forecast - Test 4",
        "description": "Calls per hour",
        "rules": [
            {
                "threshold": "0",
                "need_number": "2",
                "need_product": "1614960",
                "source_number": "5"
            }
        ],
        "api_locked": "0",
        "created_by": "3475050",
        "updated_by": null,
        "deleted_by": 3475050,
        "created_at": "2017-09-12 14:20:24",
        "updated_at": null,
        "deleted_at": "2017-09-13 09:03:28"
    },
    "token": "27d132950f709271eab980935924bd6bb6204ba1",
    "error": null
}

Query Params

datatype_id
int32

Datatype ID which needs to be deleted

 

Deletes a datatype by ID

Suggest Edits

DELETE Forecast(Datatype) by unique_id

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://www.humanity.com/api/v2/forecast/datatype/unique_id/unique_id_uid?access_token=xxxxxxx
https://www.humanity.com/api/v2/forecast/datatype/unique_id/25?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 28,
        "unique_id": "25",
        "company_id": 303579,
        "name": "Forecast - Test",
        "description": "how many customers per day visits our store",
        "rules": [
            {
                "threshold": "0",
                "need_number": "2",
                "need_product": "1614960",
                "source_number": "5"
            }
        ],
        "api_locked": "0",
        "created_by": "3475050",
        "updated_by": "3475050",
        "deleted_by": 3475050,
        "created_at": "2017-09-12 12:35:11",
        "updated_at": "2017-09-12 12:38:12",
        "deleted_at": "2017-09-13 09:16:59"
    },
    "token": "xxxxxxx",
    "error": null
}

Query Params

unique_id_uid
int32

Unique ID of the data type that needs to be deleted (Unique ID is the ID that we can set in the app or through API)

 

Deletes a datatype by unique_id

Suggest Edits

POST Datapoint

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/forecast/datapoint?access_token=xxxxxxx
value=9
data_type_id=32
period=2017-09-10 10:00:00
https://www.humanity.com/api/v2/forecast/datapoint?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 159,
        "company_id": 303579,
        "forecast_data_type_id": 32,
        "value": 9,
        "period": "2017-09-10 10:00:00",
        "created_by": 3475050,
        "updated_by": null,
        "deleted_by": null,
        "created_at": "2017-09-13 10:25:16",
        "updated_at": null,
        "deleted_at": null,
        "hour": "10:00am"
    },
    "token": "xxxxxx",
    "error": null
}

Form Data

value
string
required

Sets the name of the Forecast/Datatype

datatype_id
string
required

Adds a description for this forecast/datatype

period
date
required

Sets the unique id of the forecast/datatype

 

Create a new datapoint

Suggest Edits

GET Datapoints

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/forecast/datapoints/datatype_id?first_day=start_today&last_day=end_future&access_token=xxxxxxx
https://www.humanity.com/api/v2/forecast/datapoints/29?first_day=2017-09-01&last_day=2017-09-25&access_token=xxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": [
        {
            "id": 149,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 2,
            "period": "2017-09-10 08:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-13 09:42:06",
            "updated_at": null,
            "deleted_at": null,
            "hour": "8:00am"
        },
        {
            "id": 150,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 3,
            "period": "2017-09-10 09:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-13 09:42:06",
            "updated_at": null,
            "deleted_at": null,
            "hour": "9:00am"
        },
        {
            "id": 151,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 4,
            "period": "2017-09-10 10:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-13 09:42:06",
            "updated_at": null,
            "deleted_at": null,
            "hour": "10:00am"
        },
        {
            "id": 152,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-10 11:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-13 09:42:06",
            "updated_at": null,
            "deleted_at": null,
            "hour": "11:00am"
        },
        {
            "id": 153,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 6,
            "period": "2017-09-10 12:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-13 09:42:06",
            "updated_at": null,
            "deleted_at": null,
            "hour": "12:00pm"
        },
        {
            "id": 156,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 9,
            "period": "2017-09-10 13:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-13 09:42:06",
            "updated_at": null,
            "deleted_at": null,
            "hour": "1:00pm"
        },
        {
            "id": 155,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 10,
            "period": "2017-09-10 14:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-13 09:42:06",
            "updated_at": null,
            "deleted_at": null,
            "hour": "2:00pm"
        },
        {
            "id": 154,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 11,
            "period": "2017-09-10 15:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-13 09:42:06",
            "updated_at": null,
            "deleted_at": null,
            "hour": "3:00pm"
        },
        {
            "id": 157,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-10 16:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-13 09:42:06",
            "updated_at": null,
            "deleted_at": null,
            "hour": "4:00pm"
        },
        {
            "id": 158,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 1,
            "period": "2017-09-10 17:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-13 09:42:06",
            "updated_at": null,
            "deleted_at": null,
            "hour": "5:00pm"
        }
    ],
    "token": "xxxxxxx",
    "error": null

Query Params

datatype_id
int32

Forecast(datatype) ID

first_day
date

First day for the given forecast to get the datapoints

last_day
date

Last day for the given forecast to get the datapoints

 

Returns a list of all datapoints for the given forecast

Suggest Edits

GET Datapoint

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/forecast/datapoint/datapoint_id?access_token=xxxxxxx
https://www.humanity.com//api/v2/forecast/datapoint/155?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 155,
        "company_id": 303579,
        "forecast_data_type_id": 29,
        "value": 10,
        "period": "2017-09-10 14:00:00",
        "created_by": "3475050",
        "updated_by": null,
        "deleted_by": null,
        "created_at": "2017-09-13 09:42:06",
        "updated_at": null,
        "deleted_at": null,
        "hour": "2:00pm"
    },
    "token": "xxxxxxx",
    "error": null
}

Query Params

datapoint_id
int32

Datapoint ID

 

Returns a specific datapoint

Suggest Edits

PUT Datapoint

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/forecast/datapoint/datapoint_id?access_token=xxxxxxx
https://www.humanity.com/api/v2/forecast/datapoint/155?access_token=xxxxxxx
value=177
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 155,
        "company_id": 303579,
        "forecast_data_type_id": 29,
        "value": 177,
        "period": "2017-09-10 14:00:00",
        "created_by": "3475050",
        "updated_by": 3475050,
        "deleted_by": null,
        "created_at": "2017-09-13 09:42:06",
        "updated_at": "2017-09-14 06:45:39",
        "deleted_at": null,
        "hour": "2:00pm"
    },
    "token": "xxxxxxx",
    "error": null
}

Query Params

datapoint_id
int32

Datapoint ID

Form Data

value
int32

Updates the value of the datapoint

 

Updates the datapoint

Suggest Edits

POST COPY Datapoints

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/forecast/copy/datatype_id?access_token=xxxxxxx
from_start=2017-09-17
from_end=2017-09-18
to_start=2017-09-24
to_end=2017-09-25
{{uri}}/api/v2/forecast/copy/29?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": [
        {
            "id": 183,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 1,
            "period": "2017-09-24 00:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "12:00am"
        },
        {
            "id": 184,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 2,
            "period": "2017-09-24 02:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "2:00am"
        },
        {
            "id": 185,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 3,
            "period": "2017-09-24 03:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "3:00am"
        },
        {
            "id": 186,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 4,
            "period": "2017-09-24 04:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "4:00am"
        },
        {
            "id": 187,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-24 18:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "6:00pm"
        },
        {
            "id": 188,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-24 19:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "7:00pm"
        },
        {
            "id": 189,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 1,
            "period": "2017-09-25 01:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "1:00am"
        },
        {
            "id": 190,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 2,
            "period": "2017-09-25 03:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "3:00am"
        },
        {
            "id": 191,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-25 04:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "4:00am"
        },
        {
            "id": 192,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-25 15:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "3:00pm"
        }
    ],
    "token": "xxxxxxx",
    "error": null
}

Query Params

datatype_id
int32

Datatype ID

Form Data

from_start
date
required

Start date of the datapoint that we want to copy

from_end
date

End date of the datapoint that we want to copy

to_start
date

Start date of the copied datatype

to_end
date

End date of the copied datatype

 

This endpoint copies the datapoints within datatype which is specified by {datatype_id}

Suggest Edits

GET Datapoint by datatype unique id

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/forecast/datapoints/unique_id/unique_id_uid?first_day=2017-09-01&last_day=2017-09-03&access_token=xxxxxxx
https://www.humanity.com/api/v2/forecast/datapoints/unique_id/555858?first_day=2017-09-24&last_day=2017-09-25&access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": [
        {
            "id": 183,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 1,
            "period": "2017-09-24 00:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "12:00am"
        },
        {
            "id": 184,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 2,
            "period": "2017-09-24 02:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "2:00am"
        },
        {
            "id": 185,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 3,
            "period": "2017-09-24 03:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "3:00am"
        },
        {
            "id": 186,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 4,
            "period": "2017-09-24 04:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "4:00am"
        },
        {
            "id": 187,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-24 18:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "6:00pm"
        },
        {
            "id": 188,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-24 19:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "7:00pm"
        },
        {
            "id": 189,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 1,
            "period": "2017-09-25 01:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "1:00am"
        },
        {
            "id": 190,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 2,
            "period": "2017-09-25 03:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "3:00am"
        },
        {
            "id": 191,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-25 04:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "4:00am"
        },
        {
            "id": 192,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-25 15:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-18 08:19:04",
            "updated_at": null,
            "deleted_at": null,
            "hour": "3:00pm"
        }
    ],
    "token": "xxxxxxx",
    "error": null
}

Query Params

unique_id_uid
int32

Datapoint unique ID

first_day
date

Start day of the datapoints that we need

last_day
date

End day of the datapoints that we need

 

Returns datapoints for the given datatype

Suggest Edits

PUT Datapoint by the datatype unique id

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
puthttps://www.humanity.com/api/v2/forecast/datapoint/unique_id/unique_id_uid?access_token=xxxxxxx
https://www.humanity.com/api/v2/forecast/datapoint/unique_id/555858?access_token=xxxxxxx
value=8
period=2017-09-24 10:00:00
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": {
        "id": 222,
        "company_id": 303579,
        "forecast_data_type_id": 29,
        "value": 8,
        "period": "2017-09-24 10:00:00",
        "created_by": 3475050,
        "updated_by": null,
        "deleted_by": null,
        "created_at": "2017-09-24 20:37:05",
        "updated_at": null,
        "deleted_at": null,
        "hour": "10:00am"
    },
    "token": "xxxxxxx",
    "error": null
}

Query Params

unique_id_uid
int32

Datapoint unique ID

Form Data

value
int32

Updates the value of the datapoint

period
date-time

The time of the datapoint that we want to update eg (2017-09-24 10:00:00)

 

Updates the datapoint by the datatype unique id

Suggest Edits

POST COPY Datapoints by datatype unique ID

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
posthttps://www.humanity.com/api/v2/forecast/copy/unique_id/unique_id_uid?access_token=xxxxxxx
from_start=2017-09-24
from_end=17-09-25
to_start=017-09-27
to_end=017-09-28
https://www.humanity.com/api/v2/forecast/copy/unique_id/555858?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": [
        {
            "id": 223,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 1,
            "period": "2017-09-27 00:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "12:00am"
        },
        {
            "id": 224,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 2,
            "period": "2017-09-27 02:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "2:00am"
        },
        {
            "id": 225,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 3,
            "period": "2017-09-27 03:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "3:00am"
        },
        {
            "id": 226,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 4,
            "period": "2017-09-27 04:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "4:00am"
        },
        {
            "id": 227,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 8,
            "period": "2017-09-27 10:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "10:00am"
        },
        {
            "id": 228,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-27 18:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "6:00pm"
        },
        {
            "id": 229,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-27 19:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "7:00pm"
        },
        {
            "id": 230,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 1,
            "period": "2017-09-28 01:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "1:00am"
        },
        {
            "id": 231,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 2,
            "period": "2017-09-28 03:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "3:00am"
        },
        {
            "id": 232,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-28 04:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "4:00am"
        },
        {
            "id": 233,
            "company_id": 303579,
            "forecast_data_type_id": 29,
            "value": 5,
            "period": "2017-09-28 15:00:00",
            "created_by": "3475050",
            "updated_by": null,
            "deleted_by": null,
            "created_at": "2017-09-24 20:44:01",
            "updated_at": null,
            "deleted_at": null,
            "hour": "3:00pm"
        }
    ],
    "token": "xxxxxxx",
    "error": null
}

Query Params

unique_id_uid
int32

Datatype unique ID

Form Data

from_start
date
required

Start date of the datapoint that we want to copy

from_end
date

End date of the datapoint that we want to copy

to_start
date

Start date of the copied datatype

to_end
date

End date of the copied datatype

 

This endpoint copies the datapoints within datatype which is specified by {unique_id_uid}

Suggest Edits

CREATE Datapoints

Permission level: 5

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/forecast/datapoints?access_token=xxxxxxxxxxx
https://www.humanity.com/api/v2/forecast/datapoints?access_token=xxxxxxxxx
data:[{"value":"9","data_type_id":"32","period":"2018-02-05 11:00:00"},{"value":"10","data_type_id":"32","period":"2018-02-05 12:00:00"}]
A binary file was returned

You couldn't be authenticated

{
    "status": 1,
    "data": true,
    "token": "xxxxxxxxxxxxxxxxx"
}

Query Params

data
json

[{"key":"data","value":"[{\"value\":\"9\",\"data_type_id\":\"29\",\"period\":\"2018-02-02 10:00:00\"}]","type":"text","enabled":true}]

 

Mass datapoint creation

Suggest Edits

GET Shifts

/shifts
Permission level: 7

 

Query Auth

 Authentication is required for this endpoint.
gethttps://www.humanity.com/api/v2/shifts
https://www.humanity.com/api/v2/shifts?access_token=xxxxxxx
A binary file was returned

You couldn't be authenticated

{
  "status": 1,
  "data": [
    {
      "id": "321823010",
      "created": "1472128649",
      "published": "1472128658",
      "edited": "1472128649",
      "deleted": "0",
      "schedule": "1324363",
      "type": "0",
      "needed": "0",
      "working": "1",
      "user": "2736727",
      "start_date": {
        "id": 2676,
        "month": 8,
        "day": 26,
        "wday": 5,
        "year": 2016,
        "weekday": "Fri",
        "mname": "Aug",
        "week": 34,
        "dayid": 6,
        "timeid": 45,
        "timeid_exact": 45,
        "formatted": "Aug 26, 2016",
        "time": "11:00am",
        "timestamp": 1472202000,
        "hours": 11,
        "minutes": 0,
        "seconds": 0,
        "date": "2016-08-26 11:00:00",
        "day_of_year": "238",
        "week_adjusted": 34,
        "sp_wday": 6
      },
      "end_date": {
        "id": 2676,
        "month": 8,
        "day": 26,
        "wday": 5,
        "year": 2016,
        "weekday": "Fri",
        "mname": "Aug",
        "week": 34,
        "dayid": 6,
        "timeid": 73,
        "timeid_exact": 73,
        "formatted": "Aug 26, 2016",
        "time": "6:00pm",
        "timestamp": 1472227200,
        "hours": 18,
        "minutes": 0,
        "seconds": 0,
        "date": "2016-08-26 18:00:00",
        "day_of_year": "238",
        "week_adjusted": 34,
        "sp_wday": 6
      },
      "length": 7,
      "title": "",
      "location": "0",
      "notes": "",
      "confirmed": "0",
      "ref": "0",
      "start_timestamp": "2016-08-26 11:00:00",
      "end_timestamp": "2016-08-26 18:00:00",
      "traded": "0",
      "confirmed_start_timestamp": null,
      "confirmed_end_timestamp": null,
      "absent": "0",
      "perms": "2",
      "schedule_name": "Shop Manager",
      "schedule_color": "29",
      "schedule_location_id": "542311",
      "cost": {
        "staff": 1,
        "hours": 7,
        "dollars": 0
      },
      "start_time": {
        "id": 45,
        "time": "11:00am"
      },
      "end_time": {
        "id": 73,
        "time": "6:00pm"
      },
      "paidtime": 7,
      "employees": [
        {
          "id": "2744096",
          "avatar": "0",
          "name": "Michael Rivas",
          "status": "1",
          "wage": "",
          "notified_day": "0",
          "notified_hour": "0",
          "last_active": "0",
          "rate": "",
          "ratecard": "0",
          "absent": "0",
          "cost": 0,
          "confirmed_start": null,
          "confirmed_end": null
        }
      ],
      "trades": null
    },
    {
      "id": "321823011",
      "created": "1472128649",
      "published": "1472128658",
      "edited": "1472128649",
      "deleted": "0",
      "schedule": "1321635",
      "type": "0",
      "needed": "0",
      "working": "1",
      "user": "2736727",
      "start_date": {
        "id": 2676,
        "month": 8,
        "day": 26,
        "wday": 5,
        "year": 2016,
        "weekday": "Fri",
        "mname": "Aug",
        "week": 34,
        "dayid": 6,
        "timeid": 61,
        "timeid_exact": 61,
        "formatted": "Aug 26, 2016",
        "time": "3:00pm",
        "timestamp": 1472216400,
        "hours": 15,
        "minutes": 0,
        "seconds": 0,
        "date": "2016-08-26 15:00:00",
        "day_of_year": "238",
        "week_adjusted": 34,
        "sp_wday": 6
      },
      "end_date": {
        "id": 2676,
        "month": 8,
        "day": 26,
        "wday": 5,
        "year": 2016,
        "weekday": "Fri",
        "mname": "Aug",
        "week": 34,
        "dayid": 6,
        "timeid": 93,
        "timeid_exact": 93,
        "formatted": "Aug 26, 2016",
        "time": "11:00pm",
        "timestamp": 1472245200,
        "hours": 23,
        "minutes": 0,
        "seconds": 0,
        "date": "2016-08-26 23:00:00",
        "day_of_year": "238",
        "week_adjusted": 34,
        "sp_wday": 6
      },
      "length": 8,
      "title": "",
      "location": "0",
      "notes": "",
      "confirmed": "0",
      "ref": "0",
      "start_timestamp": "2016-08-26 15:00:00",
      "end_timestamp": "2016-08-26 23:00:00",
      "traded": "0",
      "confirmed_start_timestamp": null,
      "confirmed_end_timestamp": null,
      "absent": "0",
      "perms": "2",
      "schedule_name": "Waiter",
      "schedule_color": "10",
      "schedule_location_id": "0",
      "cost": {
        "staff": 1,
        "hours": 8,
        "dollars": 0
      },
      "start_time": {
        "id": 61,
        "time": "3:00pm"
      },
      "end_time": {
        "id": 93,
        "time": "11:00pm"
      },
      "paidtime": 8,
      "employees": [
        {
          "id": "2744098",
          "avatar": "0",
          "name": "Timothy Edison",
          "status": "1",
          "wage": "",
          "notified_day": "0",
          "notified_hour": "0",
          "last_active": "0",
          "rate": "",
          "ratecard": "0",
          "absent": "0",
          "cost": 0,
          "confirmed_start": null,
          "confirmed_end": null
        }
      ],
      "trades": null
    },
    {
      "id": "321823012",
      "created": "1472128649",
      "published": "1472128658",
      "edited": "1472128649",
      "deleted": "0",
      "schedule": "1324358",
      "type": "0",
      "needed": "0",
      "working": "1",
      "user": "2736727",
      "start_date": {
        "id": 2677,
        "month": 8,
        "day": 27,
        "wday": 6,
        "year": 2016,
        "weekday": "Sat",
        "mname": "Aug",
        "week": 34,
        "dayid": 7,
        "timeid": 25,
        "timeid_exact": 25,
        "formatted": "Aug 27, 2016",
        "time": "6:00am",
        "timestamp": 1472270400,
        "hours": 6,
        "minutes": 0,
        "seconds": 0,
        "date": "2016-08-27 06:00:00",
        "day_of_year": "239",
        "week_adjusted": 34,
        "sp_wday": 7
      },
      "end_date": {
        "id": 2677,
        "month": 8,
        "day": 27,
        "wday": 6,
        "year": 2016,
        "weekday": "Sat",
        "mname": "Aug",
        "week": 34,
        "dayid": 7,
        "timeid": 69,
        "timeid_exact": 69,
        "formatted": "Aug 27, 2016",
        "time": "5:00pm",
        "timestamp": 1472310000,
        "hours": 17,
        "minutes": 0,
        "seconds": 0,
        "date": "2016-08-27 17:00:00",
        "day_of_year": "239",
        "week_adjusted": 34,
        "sp_wday": 7
      },
      "length": 11,
      "title": "",
      "location": "0",
      "notes": "",
      "confirmed": "0",
      "ref": "0",
      "start_timestamp": "2016-08-27 06:00:00",
      "end_timestamp": "2016-08-27 17:00:00",
      "traded": "0",
      "confirmed_start_timestamp": null,
      "confirmed_end_timestamp": null,
      "absent": "0",
      "perms": "2",
      "schedule_name": "Barista",
      "schedule_color": "1",
      "schedule_location_id": "542311",
      "cost": {
        "staff": 1,
        "hours": 11,
        "dollars": 0
      },
      "start_time": {
        "id": 25,
        "time": "6:00am"
      },
      "end_time": {
        "id": 69,
        "time": "5:00pm"
      },
      "paidtime": 11,
      "employees": [
        {
          "id": "2744095",
          "avatar": "0",
          "name": "Kian Simonette",
          "status": "1",
          "wage": "",
          "notified_day": "0",
          "notified_hour": "0",
          "last_active": "0",
          "rate": "",
          "ratecard": "0",
          "absent": "0",
          "cost": 0,
          "confirmed_start": null,
          "confirmed_end": null
        }
      ],
      "trades": null
    },
    {
      "id": "321823013",
      "created": "1472128649",
      "published": "1472128658",
      "edited": "1472128649",
      "deleted": "0",
      "schedule": "1324361",
      "type": "0",
      "needed": "0",
      "working": "1",
      "user": "2736727",
      "start_date": {
        "id": 2677,
        "month": 8,
        "day": 27,
        "wday": 6,
        "year": 2016,
        "weekday": "Sat",
        "mname": "Aug",
        "week": 34,
        "dayid": 7,
        "timeid": 33,
        "timeid_exact": 33,
        "formatted": "Aug 27, 2016",
        "time": "8:00am",
        "timestamp": 1472277600,
        "hours": 8,
        "minutes": 0,
        "seconds": 0,
        "date": "2016-08-27 08:00:00",
        "day_of_year": "239",
        "week_adjusted": 34,
        "sp_wday": 7
      },
      "end_date": {
        "id": 2677,
        "month": 8,
        "day": 27,
        "wday": 6,
        "year": 2016,
        "weekday": "Sat",
        "mname": "Aug",
        "week": 34,
        "dayid": 7,
        "timeid": 65,
        "timeid_exact": 65,
        "formatted": "Aug 27, 2016",
        "time": "4:00pm",
        "timestamp": 1472306400,
        "hours": 16,
        "minutes": 0,
        "seconds": 0,
        "date": "2016-08-27 16:00:00",
        "day_of_year": "239",
        "week_adjusted": 34,
        "sp_wday": 7
      },
      "length": 8,
      "title": "",
      "location": "0",
      "notes": "",
      "confirmed": "0",
      "ref": "0",
      "start_timestamp": "2016-08-27 08:00:00",
      "end_timestamp": "2016-08-27 16:00:00",
      "traded": "0",
      "confirmed_start_timestamp": null,
      "confirmed_end_timestamp": null,
      "absent": "0",
      "perms": "2",
      "schedule_name": "Customer service",
      "schedule_color": "25",
      "schedule_location_id": "542311",
      "cost": {
        "staff": 1,
        "hours": 8,
        "dollars": 0
      },
      "start_time": {
        "id": 33,
        "time": "8:00am"
      },
      "end_time": {
        "id": 65,
        "time": "4:00pm"
      },
      "paidtime": 8,
      "employees": [
        {
          "id": "2744097",
          "avatar": "0",
          "name": "Sheri Downer",
          "status": "1",
          "wage": "",
          "notified_day": "0",
          "notified_hour": "0",
          "last_active": "0",
          "rate": "",
          "ratecard": "0",
          "absent": "0",
          "cost": 0,
          "confirmed_start": null,
          "confirmed_end": null
        }
      ],
      "trades": null
    },
    {
      "id": "321823014",
      "created": "1472128649",
      "published": "1472128658",
      "edited": "1472128649",
      "deleted": "0",
      "schedule": "1321636",
      "type": "0",
      "needed": "0",
      "working": "1",
      "user": "2736727",
      "start_date": {
        "id": 2677,
        "month": 8,
        "day": 27,
        "wday": 6,
        "year": 2016,
        "weekday": "Sat",
        "mname": "Aug",
        "week": 34,
        "dayid": 7,
        "timeid": 61,
        "timeid_exact": 61,
        "formatted": "Aug 27, 2016",
        "time": "3:00pm",
        "timestamp": 1472302800,
        "hours": 15,
        "minutes": 0,
        "seconds": 0,
        "date": "2016-08-27 15:00:00",
        "day_of_year": "239",
        "week_adjusted": 34,
        "sp_wday": 7
      },
      "end_date": {
        "id": 2677,
        "month": 8,
        "day": 27,
        "wday": 6,
        "year": 2016,
        "weekday": "Sat",
        "mname": "Aug",
        "week": 34,
        "dayid": 7,
        "timeid": 93,
        "timeid_exact": 93,
        "formatted": "Aug 27, 2016",
        "time": "11:00pm",
        "timestamp": 1472331600,
        "hours": 23,
        "minutes": 0,
        "seconds": 0,
        "date": "2016-08-27 23:00:00",
        "day_of_year": "239",
        "week_adjusted": 34,
        "sp_wday": 7
      },
      "length": 8,
      "title": "",
      "location": "0",
      "notes": "",
      "confirmed": "0",
      "ref": "0",
      "start_timestamp": "2016-08-27 15:00:00",
      "end_timestamp": "2016-08-27 23:00:00",
      "traded": "0",
      "confirmed_start_timestamp": null,
      "confirmed_end_timestamp": null,
      "absent": "0",
      "perms": "2",
      "schedule_name": "Desk Service",
      "schedule_color": "11",
      "schedule_location_id": "0",
      "cost": {
        "staff": 1,
        "hours": 8,
        "dollars": 0
      },
      "start_time": {
        "id": 61,
        "time": "3:00pm"
      },
      "end_time": {
        "id": 93,
        "time": "11:00pm"
      },
      "paidtime": 8,
      "employees": [
        {
          "id": "2744092",
          "avatar": "0",
          "name": "Derrick Arnold",
          "status": "1",
          "wage": "",
          "notified_day": "0",
          "notified_hour": "0",
          "last_active": "0",
          "rate": "",
          "ratecard": "0",
          "absent": "0",
          "cost": 0,
          "confirmed_start": null,
          "confirmed_end": null
        }
      ],
      "trades": null
    },
    {
      "id": "321823015",
      "created": "1472128649",
      "published": "1472128658",
      "edited": "1472128649",
      "deleted": "0",
      "schedule": "1321635",
      "type": "0",
      "needed": "0",
      "working": "1",
      "user": "2736727",
      "start_date": {
        "id": 2677,
        "month": 8,
        "day": 27,
        "wday": 6,
        "year": 2016,
        "weekday": "Sat"</