API Documentation

Endpoint: POST /users

Description: Creates a new user with the provided details.

Request Body:

first_name
required
stringThe first name of the user.
last_name
required
stringThe last name of the user.
email
required
stringThe email address of the user.
phone
required
stringThe phone number of the user.
password
required
stringThe password for the user account. Must be at least 6 characters long and include one lowercase letter, one uppercase letter, one number, and one special character.
company_employee_id
nullable
stringThe company-specific employee ID.
employee_code
nullable
stringThe kiosk employee code which should be only 4 digits long.
role_id
nullable
integerThe role of the user (1 for Admin, 2 for Manager, 3 for Employee; default is 3).
track_location
nullable
booleanIndicates if location tracking is enabled (default is false).
track_mileage
nullable
booleanIndicates if mileage tracking is enabled (default is false).
pay_rate
nullable
IntegerThe pay rate for the user (default is 0).
billing_rate_type
nullable
IntegerThe billing rate type (0 for hourly, 1 for daily; default is 0)

Request Body Sample:

{
    "first_name": "Joe", // required
    "last_name": "Doe", // required
    "email": "", // required
    "phone": "03237824623", // required
    "password": "Password@123", // required 
    "company_employee_id": "674343", // nullable
    "employee_code": "", // nullable: Kiosk Employee Code
    "role_id": 2, // nullable 1 - admin, 2- manager, 3 - employee, default is 3
    "track_location": true, // nullable boolean default false
    "track_mileage": true, // nullable boolean default false
    "pay_rate": 10, // nullable default 0
    "billing_rate_type": 0, // nullable default 0 - hourly, 1 - daily
    "timesheet_option": true,
    "schedule_option": true,
    "job_option": true,
    "report_option": true,
    "whoworking_option": true
}

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