v1

latestOpenAPI 3.0.22026-07-24154101.1 MB

Users

Create User

post/v2/company/{company_id}/users

Path parameters

company_idinteger required

Company ID

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

first_namestring required

The user's first name

last_namestring required

The user's last name

preferred_first_namestring nullable

An optional alternate first name

preferred_last_namestring nullable

An optional alternate last name

location_idsinteger[] required

An array of location IDs this user will be assigned to

department_idsinteger[] nullable required

An array of department IDs this user will be assigned to. Department ID is required if this user's location has at least one department

role_idsinteger[] nullable

An array of role IDs this user will be assigned to.

emailstring

the user's email

mobile_numberstring nullable

The user's mobile phone number. Format with no spaces and include area code

home_numberstring nullable

The user's home phone number. Format with no spaces and include area code

addressstring nullable

The user's address

postal_zipstring nullable

The user's postal code or zip code

citystring nullable

The user's city

prov_statestring nullable

The user's province or state

invite_userboolean nullable

If true Invite the user to 7shifts

notesstring nullable

Notes associated with this user

hire_datestring date nullable

The hire date of this user. Format YYYY-MM-DD

type'employee' | 'asst_manager' | 'manager' | 'employer' required

The type of this user

employee_idstring nullable

Either an employee ID or an ID assigned by your payroll provider that is used in your payroll export

punch_idinteger nullable

The punch ID they punch in/out with. If no value is provided a new one will be created

birth_datestring date nullable

The user's birthdate. Format YYYY-MM-DD

language'en' | 'es' | 'fr'

The user's preferred language. Default value is en

appear_as_employeeboolean nullable

User should appear in the system as an employee. Applies to admin users only

subscribe_to_updatesboolean nullable

Subscribe this user to updates from 7shifts. This includes announcing new features for 7shifts

max_weekly_hoursnumber nullable

The maximum weekly hours this user is set to work

skill_level1 | 2 | 3 nullable

wage_centsnumber nullable

wage_type'hourly' | 'weekly_salary' nullable

The wage type

permissions_template_idinteger nullable

Id of a permissions template the user will be assigned to and granted permissions from.

Example request

{
  "email": "example@7shifts.com",
  "hire_date": "2017-05-20",
  "birth_date": "2017-07-21",
  "wages": [
    {
      "effective_date": "2020-01-01"
    }
  ]
}

Response

Created

object'user' required

Example response

{
  "data": {
    "timezone": "America/Chicago",
    "language": "en",
    "skill_level": 2,
    "wage_type": "salary"
  }
}