API Reference
Back to 7shifts.comBecome a Partner

Create User

post
https://api.7shifts.com/v2/company//users
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Minimum Plan Required: Entrée

Path Params
int64
required

Company ID

Body Params
string
required

The user's first name

string
required

The user's last name

string | null

An optional alternate first 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

the user's email

string | null

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

string | null

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

string | null

The user's address

string | null

The user's postal code or zip code

string | null

The user's city

string | null

The user's province or state

boolean | null

If true Invite the user to 7shifts

string | null

Notes associated with this user

date | null

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

string
enum
required

The type of this user

Allowed:
string | null

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

integer | null

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

date | null

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

string
enum
Defaults to en

The user's preferred language. Default value is en

Allowed:
boolean | null

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

boolean | null

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

number | null

The maximum weekly hours this user is set to work

integer | null
enum
Defaults to 2
Allowed:
number | null
string | null
enum

The wage type

Allowed:
wages
array of objects | null

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

wages
integer | null

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

Headers
string

7shifts API version

uuid

Company GUID

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 24 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 24 days ago