Create User

post https://api.7shifts.com/v2/company/{company_id}/users

Minimum Plan Required: Entrée

Path Params

company_id

int64

required

Company ID

Body Params

first_name

string

required

The user's first name

last_name

string

required

The user's last name

preferred_first_name

string | null

An optional alternate first name

preferred_last_name

string | null

An optional alternate last name

location_ids

array of integers

required

An array of location IDs this user will be assigned to

location_ids*

department_ids

array of integers | null

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

department_ids*

role_ids

array of integers | null

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

role_ids

string

required

the user's email

mobile_number

string | null

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

home_number

string | null

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

address

string | null

The user's address

postal_zip

string | null

The user's postal code or zip code

city

string | null

The user's city

prov_state

string | null

The user's province or state

invite_user

boolean | null

If true Invite the user to 7shifts

notes

string | null

Notes associated with this user

hire_date

date | null

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

type

string

required

The type of this user

employee_id

string | null

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

punch_id

integer | null

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

birth_date

date | null

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

language

string

Defaults to en

The user's preferred language. Default value is en

appear_as_employee

boolean | null

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

subscribe_to_updates

boolean | null

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

max_weekly_hours

integer | null

The maximum weekly hours this user is set to work

wage_cents

number | null

wage_type

string | null

The wage type

wages

array of objects | null

An array of Wages that will be set to the assigned User's roles

wages

Headers

x-api-version

string

7shifts API version

x-company-guid

uuid

Company GUID

Responses

Response body

object

string

required

user

data

object

required

integer

required

User ID

identity_id

integer | null

Internal use

company_id

integer

required

Company ID

first_name

string

required

length ≤ 80

First Name

last_name

string

required

length ≤ 80

Last Name

preferred_first_name

string | null

Preferred first name

preferred_last_name

string | null

Preferred last name

pronouns

string | null

Pronouns

string

required

length ≤ 155

Email Address

mobile_number

string | null

required

Mobile Number

home_number

string | null

required

Home Number

birth_date

date | null

required

Birthdate. Format YYYY-MM-DD

address

string | null

required

Address

postal_zip

string | null

required

Zip or postal code

city

string | null

required

City

prov_state

string | null

required

State or province

invite_status

string

required

Invitation status to join 7shifts

accepted pending required missing_contact_info

active

boolean

required

If true user is active in allowed to login. If false the user has been deactivated/deleted

photo

string | null

required

Photo url

notes

string | null

required

User notes

hire_date

date | null

required

Date hired. YYYY-MM-DD format

timezone

string | null

required

Timezone. Valid zone info name

type

string

required

User type

employee asst_manager manager employer

employee_id

string | null

required

Employee ID

max_weekly_hours

string

required

Maximum weekly hours user is set to work

punch_id

string | null

required

Value used during clock in/out in 7shifts applications

created

string

modified

string

invited

string | null

required

If true user has been sent an invitation to join 7shifts

invite_accepted

string | null

required

If true user has accepted 7shifts invitation

is_new

boolean

required

If true user is new

appear_as_employee

boolean

If true user can be assigned shifts. This applies to managers, asst_manager and employers.

subscribe_to_updates

boolean

If true this user is subscribed to updates from 7shifts. This includes announcing new features for 7shifts

language

string

Specified language. In ISO 639-1 format

push

boolean

Are mobile push notifications enabled for the user

skill_level

integer | null

Current assigned skill level

hourly_wage

integer | null

Users current hourly wage in cents

wage_type

string | null

The type of wage the user will receive

sms_me_schedules

boolean | null

If the user should receive sms notifications for shifts

notify_ot_risk

boolean | null

Should notifications be sent if the user is at risk of overtime hours

201Created

400Bad Request

401Unauthorized

403Forbidden

404Not found

422Unprocessable Entity

500Server Error