---
title: "POST Employee"
method: POST
path: "/employees"
---

# POST Employee

`POST /employees`

## Request

- Base URL: `https://www.humanity.com/api/v2`
- URL: `https://www.humanity.com/api/v2/employees`
- Auth: API key in query parameter `access_token`

/employees
Permission level: 4

## Request body `application/x-www-form-urlencoded`

- object
  - `name` string
  - `fname` string
  - `lname` string
  - `eid` string
  - `status` string: enum [-1, 0, 1] <br>-1: Disabled<br>0: Not Activated<br>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` integer
  - `birth_month` integer
  - `cell_phone` string
  - `wage` integer
  - `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` integer
  - `password` string: Minimum 6 characters.
  - `username` string: Minimum 3 characters.
  - `send_activation` integer: enum [1] -> 1: Send activation
  - `facebook` string
  - `google` string
  - `ldap` string
  - `language` string
  - `skills` string: Comma-separated array of skill IDs
  - `timezone_id` integer
  - `location` integer
  - `undertime` integer
  - `overtime` integer
  - `daily_overtime` integer
  - `max_days_row` integer
  - `pref_shift_autoconfirm` integer: enum [-1, 1, -2]
  - `custom` string, 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` string, json: An array of position IDs in JSON format, eg. [747311, 743314]
  - `monthly_overtime` integer
  - `monthly_undertime` integer
  - `pref_mtimebshifts` integer: enum [0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48]
  - `work_start_date` string, date
  - `employee_type` integer: enum [0, 1, 2, 3, 4, 5, 6] <br> 0 - None <br> 1 - Full Time <br> 2 - Part Time <br> 3 - Seasonal <br> 4 - Temporary <br> 5 - Contractor <br> 6 - Volunteer
  - `pay_type` integer: enum [0, 1, 2, 3, 4, 5, 6] <br> 0 - None <br> 1 - Hourly <br> 2 - Salary <br> 3 - Commission <br> 4 - Exception Hourly <br> 5 - Daily <br> 6 - Weekly <br> 7 - Monthly <br> 8 - Piece Rate <br> 9 - Contract <br> 10 - Pro Rata

## Response `200`

200

- object
  - `status` integer
  - `data` object
    - `id` string
    - `username` string
    - `tusername` string
    - `email` string
    - `title` unknown
    - `realname` string
    - `url` unknown
    - `jabber` unknown
    - `icq` unknown
    - `msn` unknown
    - `aim` unknown
    - `yahoo` unknown
    - `location` string
    - `signature` unknown
    - `disp_topics` unknown
    - `disp_posts` unknown
    - `email_setting` string
    - `notify_with_post` string
    - `auto_notify` string
    - `show_smilies` string
    - `show_img` string
    - `show_img_sig` string
    - `show_avatars` string
    - `show_sig` string
    - `access_keys` string
    - `timezone` string
    - `dst` string
    - `time_format` string
    - `date_format` string
    - `language` unknown
    - `style` string
    - `num_posts` string
    - `last_post` unknown
    - `last_search` unknown
    - `last_email_sent` unknown
    - `registered` string
    - `registration_ip` string
    - `last_visit` string
    - `last_active` string
    - `admin_note` unknown
    - `activate_string` unknown
    - `activate_key` unknown
    - `pun_bbcode_enabled` string
    - `pun_bbcode_use_buttons` string
    - `pun_pm_new_messages` unknown
    - `pun_pm_long_subject` string
    - `newsletter` string
    - `email_confirmed` string
    - `eid` unknown
    - `status` string
    - `deleted` string
    - `deleted_by` string
    - `legal_agree` string
    - `referral` string
    - `wage` unknown
    - `name` string
    - `firstname` string
    - `lastname` string
    - `nick_name` string
    - `birth_day` string
    - `birth_month` string
    - `smsgateway` unknown
    - `cell_phone` unknown
    - `cellphone_confirmed` string
    - `last_sms_sent` string
    - `home_phone` unknown
    - `avatar` object
      - `small` string
      - `medium` string
      - `large` string
    - `address` unknown
    - `city` string
    - `state` string
    - `zip` unknown
    - `notes` string
    - `p_email` string
    - `p_phone` string
    - `notify_sms` string
    - `notify_email` string
    - `e_new_pm` string
    - `ical` string
    - `24hr` string
    - `startday` string
    - `pref_caltime` string
    - `pref_shift_autoconfirm` string
    - `undertime` string
    - `overtime` string
    - `recommend` string
    - `recommendation` string
    - `tut_v2_sched` string
    - `daily_overtime` string
    - `max_days_row` string
    - `timezone_id` unknown
    - `monthly_undertime` string
    - `monthly_overtime` string
    - `pref_mtimebshifts` string
    - `avatar_url` unknown
    - `deactivated` string
    - `work_start_date` string
    - `screen_logger` string
    - `sc_freq` string
    - `newsletter_receiver` string
    - `job_title` unknown
    - `middle_name` unknown
    - `gender` string
    - `pref_sp_skin` string
    - `inline_wizard_completion` unknown
    - `teamtools_id` string
    - `updated_at` string
    - `unique_id` unknown
    - `employee_type` string
    - `pay_type` string
    - `group` string
    - `timezone_name` string
    - `group_name` string
    - `status_name` string
    - `schedules` unknown[]
      - unknown
    - `skills` unknown[]
      - unknown
    - `custom` object
      - `26768` object
        - `id` string
        - `name` string
        - `type` string
        - `access` string
        - `values` string
        - `value` unknown
        - `text` unknown
        - `toggle` unknown
      - `27043` object
        - `id` string
        - `name` string
        - `type` string
        - `access` string
        - `values` string
        - `value` string
        - `text` string
        - `toggle` string
      - `27044` object
        - `id` string
        - `name` string
        - `type` string
        - `access` string
        - `values` string
        - `value` unknown
        - `text` unknown
        - `toggle` unknown
    - `settings` object
      - `widgets_layout` array[]
        - string[]
      - `schedule_side_panel_visibility` integer
      - `linked_shift_time` integer
      - `schedule_view_selected` string
      - `schedule_timeline_selected` string
      - `schedule_budget_mode_visibility` integer
      - `schedule_forecast_graph_visibility` integer
      - `schedule_copy_rules_choice` integer
      - `shift_skill_filter_visibility` integer
      - `shift_task_assignment_visibility` integer
      - `default_location_panel_visibility` integer
      - `include_ghost_shifts` integer
      - `is_first_schedule_visit` integer
  - `token` string
  - `error` unknown

## Other responses

- `400`: 400

## Changes

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

[Operation history](https://skmtc.dev/humanity-com/apis/humanity/changes/employees/post.md)

---

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