📘

NOTE

The fields below are ones used to create a user. However, there will be other read-only fields returned when you read a user record that are part of their profile that the user would set themselves (i.e. notification settings, language preference, profile photo).

Parameters

Parameter

Type

Required

Description

company_id

Int

Yes

The company id that this user belongs to.

mapping_id

String

No

An optional field to be used for 3rd party integrations.

firstname

String

Yes

The user's first name.

lastname

String

Yes

The user's last name.

user_type_id

Int

Yes

The user type. Possibilities include:

1 (Employee)
3 (Manager)
4 (Assistant manager)

email

String

Yes

The user's email.

mobile_phone

Integer

No

The users mobile phone. No spaces and include area code (i.e. if the number is 306-123-4454, you would send along 3061234454).

home_phone

Integer

No

The users home phone. No spaces and include area code (i.e. if the number is 306-123-4454, you would send along 3061234454).

hourly_wage

Float

No

The user's hourly wage,

skill_level

Integer

No

The user's skill level. Possibilities are:

1
2
3

wage_type

String

No

Possibilities are:

hourly
weekly_salary

max_weekly_hours

Integer

No

Maximum weekly hours they're set to work.

employee_id

String

No

The punch ID that they punch in/out with.

notes

String

No

Any notes tied to that employee.

address

String

No

The address of the user.

city

String

No

The city of that the user lives in.

prov_state

String

No

The province/state in their profile.

postal_zip

String

No

The postal code/zip code in their profile.

appear_as_employee

Boolean

No

If they're appearing in the system as an employee (only for admins).

hire_date

Date

No

The date they were hired (YYYY-mm-dd format).

birth_date

Date

No

Their birth date (YYYY-mm-dd format).

Associations

In addition to saving the "user" object, you will need to pass along additional associations for that user (i.e. locations, departments, and roles they're assigned to).

Parameter

Type

Description

Example

location

Array

An array of JSON objects of location IDs that this user is assigned to.

"location_id": [{ id: 5 }, { id: 6 }]

department

Array

An array of JSON objects of department IDs that this user is assigned to.

"department_id": [{ id: 5 }, { id: 6 }]

role

Array

An array of JSON objects of role data that this user is assigned to.

"role": [
{
"id": 5,
"skill_level": 2,
"hourly_wage": 16.50,
"primary": 1
}
]

Example response

{
  "status": "success",
  "data": {
    "user": {
      "id": 123,
      "identity_id": null,
      "domain_id": 456,
      "user_type_id": 1,
      "employee_id": "",
      "payroll_id": "",
      "mapping_id": "",
      "password": "",
      "firstname": "Bob",
      "lastname": "Johnson",
      "birth_date": null,
      "home_phone": "",
      "mobile_phone": "",
      "hire_date": "0000-00-00",
      "address": "",
      "city": "",
      "prov_state": "",
      "postal_zip": "",
      "email": "",
      "notes": "",
      "mobile_me_wall_posts": true,
      "mobile_me_logbook_posts": true,
      "sms_me_schedules": true,
      "sms_me_shiftpool": true,
      "sms_me_shiftpool_requests": true,
      "sms_me_timeoff_requests": true,
      "sms_me_global_messages": true,
      "sms_me_employee_health_check": false,
      "sms_me_late_punch_in": true,
      "email_me_global_messages": true,
      "email_me_schedules": true,
      "email_me_shiftpool": true,
      "email_me_new_wall_posts": true,
      "email_me_timeoff_requests": true,
      "email_me_availability_changes": true,
      "email_me_shiftpool_requests": true,
      "email_me_punch_errors": true,
      "email_me_logbook_posts": true,
      "email_me_employee_health_check": false,
      "email_me_late_punch_in": true,
      "email_me_digest_stats": true,
      "push": false,
      "notify_ot_actual": true,
      "notify_ot_risk": true,
      "notify_break_alerts": true,
      "lang": "en",
      "subscribe_to_updates": false,
      "photo": "https://app.7shifts.com/img/nophoto/1.png",
      "hourly_wage": 0,
      "skill_level": 2,
      "wage_type": "hourly",
      "max_weekly_hours": "",
      "active": true,
      "show_notice": true,
      "show_copy_previous_dialog": true,
      "show_changes": true,
      "timezone": "",
      "appear_as_employee": true,
      "last_login": "0000-00-00 00:00:00",
      "last_password_change": "2021-08-13 01:57:06",
      "login_token": "",
      "tour_show_schedules": 1,
      "tour_show_time_off": 1,
      "tour_show_shift_pool": 1,
      "notified_punch_id": false,
      "invited": "0000-00-00 00:00:00",
      "invite_accepted": null,
      "created": "2021-08-13 01:57:06",
      "modified": "2021-08-13 01:57:06",
      "uuid": "",
      "company_id": 384,
      "invite_expiry": null
    },
    "domain": {
      "id": 456,
      "name": "Scooters",
      "url": "pizzainn",
      "country": "CA",
      "photo": "https://815eb0704ee5fefc0823-732830497efdb0e881ba2bd815804c2e.ssl.cf1.rackcdn.com/0584ce565c824b7b7f50282d9a19945b/31a9024a514953ced2e1fb18361b0178_57127.jpg",
      "contact_page": true,
      "wall_page": true,
      "contact_page_account_creator_info": 1,
      "start_week_on": 1,
      "weekly_availability": true,
      "private_scheduling": false,
      "notify_with_shifts": true,
      "trial": 1,
      "plan_id": "gourmet-v2-annual",
      "corporate_group": "",
      "active": 1,
      "cc_exp": "0000-00-00",
      "cc_prov_state": "",
      "cc_country": "",
      "coupon": "",
      "using_events": true,
      "time_off_request_notice": 0,
      "employee_availability": true,
      "assume_available": true,
      "availability_allow_submit_published": false,
      "availability_comments_required": true,
      "availability_message": " ",
      "availability_approvals": true,
      "shift_pool": true,
      "shift_pool_require_approval": true,
      "account_wide_shiftpool": true,
      "layout": "role",
      "shift_splitting": false,
      "industry": "",
      "labor_auto_break": true,
      "labor_auto_break_hours": 8,
      "labor_auto_break_minutes": 30,
      "labor_auto_break_hours_2": 0,
      "labor_auto_break_minutes_2": 0,
      "labor_overtime": true,
      "jurisdiction": null,
      "labor_overtime_daily_hours": 8,
      "labor_overtime_daily_times": 1.5,
      "labor_overtime_weekly_hours": 40,
      "labor_overtime_weekly_times": 1.5,
      "labor_overtime_daily_premium_minutes": 12,
      "labor_overtime_daily_premium_multiplier": 2,
      "wage_based_roles": true,
      "reports_split_holidays": true,
      "employee_max": 0,
      "setup_company_settings": true,
      "setup_invited_employee_count": 535,
      "setup_location_close_times": true,
      "setup_unlocked_trial": true,
      "setup_manual_hide_notice": false,
      "api_key": "ABC123TYUI23423498FKJSDKJH23234",
      "utm_source": "",
      "utm_medium": "",
      "utm_campaign": "",
      "utm_content": null,
      "utm_term": null,
      "form_type": null,
      "content_source": null,
      "crm_id": "00Q1I00000B2EjAUAV",
      "account_manager": false,
      "converted": "0000-00-00 00:00:00",
      "cancelled": false,
      "created_on_mobile": false,
      "website_footer_discount": "",
      "pos": "shopkeep",
      "max_working_days": 6,
      "sales_projection_interval": 60,
      "min_shift_length": 5,
      "max_shift_length": 8,
      "ot_alerts": 1,
      "ot_alerts_buffer_minutes": 60,
      "multi_location_billing": true,
      "clover_account": false,
      "restaurant_types": "coffeeshop;pizzeria",
      "created": "2012-02-21 20:57:33",
      "modified": "2021-08-11 23:13:17",
      "expires": "2023-01-02 10:00:00",
      "ran_migration": true,
      "time_off_request_comment": true,
      "crm_assignee": null,
      "uuid": ""
    },
    "permission": {
      "id": 444,
      "user_id": 123,
      "domain_id": 456,
      "sched_manage": false,
      "sched_d": false,
      "emp_c": false,
      "emp_e": false,
      "emp_d": false,
      "emp_labor_cost": false,
      "post_d": false,
      "timeoff_approve_decline": false,
      "timeoff_manage": false,
      "timeoff_approve_decline_own": false,
      "shiftpool_approve_decline": false,
      "availability_manage": false,
      "roles_manage": false,
      "events_manage": false,
      "templates_manage": false,
      "labor_manage": false,
      "sales_manage": false,
      "reports": false,
      "timepunch_crud": false,
      "timepunch_crud_self": false,
      "timepunch_period_edit": false,
      "compliance_exceptions_manage": false,
      "picture_punch_view": false,
      "enterprise_overview": false,
      "restrict_billing": false,
      "tasks_manage": false,
      "view_shift_feedback": false,
      "health_check_data_view": false,
      "hiring_view_page": false,
      "hiring_manage_job_postings": false,
      "hiring_manage_candidate_notes": false,
      "tip_pool_manage": false,
      "tip_pool_report": false,
      "can_manage_tasks_settings": false
    },
    "group": [
      {
        "id": 456,
        "domain_id": 789,
        "mapping_id": "",
        "country": "US",
        "state": "FL",
        "city": "",
        "address": "Burnaby - Dining (DAY)",
        "lat": 27.94802415,
        "lng": "-82.46073329",
        "formatted_address": "Tampa FLL Homes for Sale, West Cleveland Street, Tampa, FL, USA",
        "place_id": "ChIJ8cdOYoPEwogRWdO_sB_kd44",
        "timezone": "America/Regina",
        "timezone_updated": true,
        "hash": "685a93b2342341a7b1f7da5cfce896",
        "message": " ",
        "holiday_pay": true,
        "shift_feedback": false,
        "department_based_budget": false,
        "mon_hours_open": "07:00:00",
        "tue_hours_open": "07:45:00",
        "wed_hours_open": "07:15:00",
        "thu_hours_open": "12:15:00",
        "fri_hours_open": "07:00:00",
        "sat_hours_open": "07:00:00",
        "sun_hours_open": "12:00:00",
        "mon_hours_close": "22:00:00",
        "tue_hours_close": "23:00:00",
        "wed_hours_close": "00:00:00",
        "thu_hours_close": "01:00:00",
        "fri_hours_close": "23:00:00",
        "sat_hours_close": "00:00:00",
        "sun_hours_close": "01:00:00",
        "mon_closed": false,
        "tue_closed": false,
        "wed_closed": false,
        "thu_closed": false,
        "fri_closed": false,
        "sat_closed": false,
        "sun_closed": false,
        "auto_send_log_book_time": null,
        "deleted": null,
        "created": "2012-02-21 20:57:33",
        "modified": "2021-08-09 17:09:50",
        "uuid": "",
        "groups_user": {
          "id": 1,
          "group_id": 456,
          "user_id": 123,
          "sort": 159,
          "deleted": null,
          "created": "2021-08-13 01:57:06",
          "modified": "2021-08-13 01:57:06"
        }
      }
    ],
    "role": [],
    "schedule_type": [
      {
        "id": 1,
        "domain_id": 123,
        "group_id": 345,
        "name": "Back of house",
        "default": 0,
        "deleted": null,
        "created": "2018-09-17 16:08:54",
        "modified": "2021-08-13 01:56:43",
        "uuid": "",
        "location_id": 456,
        "users_schedule_type": {
          "id": 33322,
          "user_id": 123,
          "schedule_type_id": 445,
          "sort": 69,
          "appear_on_schedule": 1,
          "deleted": null
        }
      }
    ]
  },
  "message": "User added."
}
Language
Authentication
Basic
base64
:
Response
Click Try It! to start a request and see the response here!