v1/users

post deprecated

https://shyftplan.com/api/v1/users

DEPRECATED: Please use post api/v2/employments instead. Create a User employment

Body Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

billing_type_id

int32

enum

1 = abrechnen (is billed); 2 = nicht abrechnen (is not billed)

Allowed:

string

employment_work_hour_attributes[mon_minutes]

int32

employment_work_hour_attributes[tue_minutes]

int32

employment_work_hour_attributes[wed_minutes]

int32

employment_work_hour_attributes[thu_minutes]

int32

employment_work_hour_attributes[fri_minutes]

int32

employment_work_hour_attributes[sat_minutes]

int32

employment_work_hour_attributes[sun_minutes]

int32

employment_work_hour_attributes[vacation_minutes]

int32

exit_date

date

exit_month_payed_partially

boolean

first_name

string

required

last_name

string

required

is_paid_monthly

boolean

maximum_money

float

maximum_money_enabled

boolean

max_vacation_days

float

note

string

password

string

phone_number

string

sso_only

boolean

Defaults to false

Boolean flag to determine if the user must log in via SSO. Can only be changed by a super-admin

staff_number

string

user_token

int32

Response

201

DEPRECATED: Please use post api/v2/employments instead. Create a User employment

Language

Loading…

Response

Click Try It! to start a request and see the response here!