v1
latestOpenAPI 3.1.02026-07-2612071.0 KBGET Employee by Unique ID
/employees/unique_id/:unique_id Permission level: 5
get/employees/unique_id/{unique_id}
Path parameters
unique_idstring required
The 'unique_id' parameter is a customizable identifier that serves as an alternative means to retrieve a specific employee. This value can be set by calling the POST or PUT employee API endpoints.
Response
2XX
Example response
{
"status": 1,
"data": {
"id": "7570782",
"eid": "a007",
"status": "1",
"deleted": "0",
"deleted_by": "0",
"legal_agree": "0",
"referral": "0",
"location": "0",
"wage": "0",
"name": "Anastasia Papadopulos",
"nick_name": " ",
"birth_day": "0",
"birth_month": "0",
"email": "anastasiap@cloudtech.gr",
"email_confirmed": "0",
"cell_phone": " ",
"cellphone_confirmed": "0",
"city": "Athens",
"state": "GR",
"username": "anastasia",
"realname": "Anastasia Papadopulos",
"timezone_id": "313",
"daily_overtime": "0",
"updated_at": "2023-12-14 08:28:08",
"avatar": {
"small": "/app/layout/images/no_avatar.png",
"medium": "/app/layout/images/no_avatar.png",
"large": "/app/layout/images/no_avatar.png"
},
"unique_id": "1000-axcR-3580",
"job_title": " ",
"gender": "F",
"employee_type": "0",
"pay_type": "0",
"work_start_date": "2023-01-03 17:00:00",
"home_phone": " ",
"last_visit": "1677077162",
"registered": "1673365570",
"smsgateway": "-1",
"notes": "She did a great job during migration to the new hosting provider! Score 10/10",
"pref_shift_autoconfirm": "-1",
"undertime": "0",
"overtime": "-1",
"max_days_row": "-1",
"monthly_undertime": "0",
"monthly_overtime": "-1",
"pref_mtimebshifts": "0",
"middle_name": " ",
"registration_ip": "10.10.10.10",
"vendor_id": 1,
"email_setting": "1",
"notify_with_post": "0",
"auto_notify": "0",
"show_smilies": "1",
"show_avatars": "1",
"show_sig": "1",
"access_keys": "0",
"dst": "0",
"time_format": "0",
"date_format": "0",
"style": "ShiftPlanning",
"num_posts": "0",
"pun_bbcode_enabled": "1",
"pun_bbcode_use_buttons": "1",
"pun_pm_long_subject": "1",
"newsletter": "1",
"last_sms_sent": "0",
"p_email": "1",
"p_phone": "1",
"notify_sms": "-1",
"notify_email": "1",
"e_new_pm": "0",
"ical": "https://www.humanity.com/ical/b7ee52728e4c49bbbb05d635b4087f47.ics",
"startday": "1",
"pref_caltime": "10",
"tut_v2_sched": "0",
"screen_logger": "0",
"sc_freq": "-2",
"newsletter_receiver": "0",
"pref_sp_skin": "0",
"recommend": "0",
"firstname": "Anastasia",
"lastname": "Papadopulos",
"tusername": "anastasia",
"24hr": "0",
"group": "5",
"last_active": "1677189387",
"timezone": "313",
"timezone_name": "Europe/Athens",
"timezone_info": {
"timezone_id": "313",
"name": "Europe/Athens",
"name_formatted": "(UTC +02:00) Europe/Athens",
"offset": "+2:00",
"seconds": 7200,
"hours": 2,
"default": "0"
},
"group_name": "Employee",
"status_name": "Activated",
"schedules": {
"2966058": "CloudOps"
},
"skills": {
"82456": "CCNA",
"82458": "Oracle certified"
},
"custom": {
"27044": {
"id": "27044",
"name": "Has children",
"type": "4",
"access": "1",
"vendor_id": "1",
"toggle": "0"
},
"32708": {
"id": "32708",
"name": "License Number",
"type": "1",
"access": "1",
"vendor_id": "1",
"toggle": "0"
},
"32712": {
"id": "32712",
"name": "Additional notes",
"type": "2",
"access": "1",
"vendor_id": "1",
"toggle": "0"
},
"33913": {
"id": "33913",
"name": "Certification Date",
"type": "6",
"access": "1",
"vendor_id": "1",
"toggle": "0"
},
"43912": {
"id": "43912",
"name": "Custom Field 1",
"type": "1",
"access": "1",
"vendor_id": "1",
"toggle": "0"
},
"44987": {
"id": "44987",
"name": "SSN",
"type": "5",
"access": "1",
"vendor_id": "1",
"toggle": "0"
},
"44989": {
"id": "44989",
"name": "Shirt Size",
"type": "3",
"access": "1",
"values": "XXS,XS,S,M,L,XL,XXL,3XL,4XL,5XL",
"vendor_id": "1",
"toggle": "0"
}
},
"settings": {
"widgets_layout": [
[
"timeclock"
]
],
"widgets_enabled": [
"timeclock"
],
"schedule_side_panel_visibility": 1,
"linked_shift_time": 1,
"schedule_view_selected": "week",
"schedule_timeline_selected": "employee",
"default_location_panel_visibility": 1,
"is_new_shift_creation_enabled": 1,
"notifications": {
"channel_email": 1,
"channel_sms": 1,
"channel_mobile_push": 1,
"email": {
"m_training_removed": 2,
"m_training_topic_updated": 2,
"m_homework_approved": 2,
"m_homework_rejected": 2,
"m_training_added": 2,
"m_training_comment": 2,
"m_shift_added_oncall": 2,
"m_shift_trade_pickup_reject": 2,
"m_removed_from_shift": 2,
"m_added_to_shift": 2,
"m_shift_confirmed_new": 2,
"m_booked_removed": 2,
"m_published": 2,
"m_shift_removed_oncall": 2,
"m_remind_hour": 2,
"m_schedule_note": 2,
"m_remind_day": 2,
"m_shift_confirmed_old": 2,
"m_shift_release_completed": 2,
"m_shift_trade_completed": 2,
"m_shift_pickup_rejected_employee": 2,
"m_shiftswap_accepted": 2,
"m_shiftswap_rejected": 2,
"m_shiftswap_request": 2,
"m_republished": 2,
"m_shift_dropped": 2,
"m_shiftswap_admin_reject_accepted": 2,
"m_trade_invites": 2,
"m_shiftswap_admin_rejected": 2,
"m_shift_pickup_rejected": 2,
"m_remind_clockout": 2,
"m_remind_clockin": 2,
"m_message_wall_post": 2,
"m_message_wall_reply": 2,
"m_future_availability_approved": 2,
"m_weekly_availability_approved": 2,
"m_future_availability_rejected": 2,
"m_weekly_availability_rejected": 2,
"m_birthday_card": 2,
"new_pm": 2,
"m_vacation_reject": 2,
"m_vacation_accept": 2,
"m_vacation_remove": 2,
"m_shift_deleted": 2,
"m_paid_break": 2,
"m_unpaid_break": 2,
"m_availability_rejected": 2,
"m_availability_approved": 2,
"m_availability_daily_summary": 2,
"m_availability_last_minute_change": 2,
"m_availability_absence": 2,
"m_remind_upcoming_schedules": 2
},
"sms": {
"m_training_removed": 2,
"m_training_topic_updated": 2,
"m_homework_approved": 2,
"m_homework_rejected": 2,
"m_training_added": 2,
"m_training_comment": 2,
"m_shift_added_oncall": 2,
"m_shift_trade_pickup_reject": 2,
"m_removed_from_shift": 2,
"m_added_to_shift": 2,
"m_shift_confirmed_new": 2,
"m_booked_removed": 2,
"m_published": 2,
"m_shift_removed_oncall": 2,
"m_remind_hour": 2,
"m_schedule_note": 2,
"m_remind_day": 2,
"m_shift_confirmed_old": 2,
"m_shift_release_completed": -1,
"m_shift_trade_completed": -1,
"m_shift_pickup_rejected_employee": 2,
"m_shiftswap_accepted": 2,
"m_shiftswap_rejected": 2,
"m_shiftswap_request": 2,
"m_republished": 2,
"m_shift_dropped": 2,
"m_shiftswap_admin_reject_accepted": 2,
"m_trade_invites": 2,
"m_shiftswap_admin_rejected": 2,
"m_shift_pickup_rejected": 2,
"m_remind_clockout": 2,
"m_remind_clockin": 2,
"m_message_wall_post": 2,
"m_message_wall_reply": 2,
"m_future_availability_approved": 2,
"m_weekly_availability_approved": 2,
"m_future_availability_rejected": 2,
"m_weekly_availability_rejected": 2,
"m_birthday_card": 2,
"new_pm": 2,
"m_vacation_reject": 2,
"m_vacation_accept": 2,
"m_vacation_remove": 2,
"m_shift_deleted": 2,
"m_paid_break": 2,
"m_unpaid_break": 2,
"m_availability_rejected": 2,
"m_availability_approved": 2,
"m_availability_daily_summary": 2,
"m_availability_last_minute_change": 2,
"m_availability_absence": 2,
"m_remind_upcoming_schedules": 2
},
"mobile_push": {
"m_training_removed": 2,
"m_training_topic_updated": 2,
"m_homework_approved": 2,
"m_homework_rejected": 2,
"m_training_added": 2,
"m_training_comment": 2,
"m_shift_added_oncall": 2,
"m_shift_trade_pickup_reject": 2,
"m_removed_from_shift": 2,
"m_added_to_shift": 2,
"m_shift_confirmed_new": 2,
"m_booked_removed": 2,
"m_published": 2,
"m_shift_removed_oncall": 2,
"m_remind_hour": 2,
"m_schedule_note": 2,
"m_remind_day": 2,
"m_shift_confirmed_old": 2,
"m_shift_release_completed": -1,
"m_shift_trade_completed": -1,
"m_shift_pickup_rejected_employee": 2,
"m_shiftswap_accepted": 2,
"m_shiftswap_rejected": 2,
"m_shiftswap_request": 2,
"m_republished": 2,
"m_shift_dropped": 2,
"m_shiftswap_admin_reject_accepted": 2,
"m_trade_invites": 2,
"m_shiftswap_admin_rejected": 2,
"m_shift_pickup_rejected": 2,
"m_remind_clockout": 2,
"m_remind_clockin": 2,
"m_message_wall_post": 2,
"m_message_wall_reply": 2,
"m_future_availability_approved": 2,
"m_weekly_availability_approved": 2,
"m_future_availability_rejected": 2,
"m_weekly_availability_rejected": 2,
"m_birthday_card": 2,
"new_pm": 2,
"m_vacation_reject": 2,
"m_vacation_accept": 2,
"m_vacation_remove": 2,
"m_shift_deleted": 2,
"m_paid_break": 2,
"m_unpaid_break": 2,
"m_availability_rejected": 2,
"m_availability_approved": 2,
"m_availability_daily_summary": 2,
"m_availability_last_minute_change": 2,
"m_availability_absence": 2,
"m_remind_upcoming_schedules": -1
}
}
},
"permissions": {
"allow_wage_and_budget": true
}
},
"token": "35a958a08d1bace239465a23dcfa7a7fb5bcf5db"
}