API Reference

Add a new Employee record

post
https://api.worklio.com/wep/companies//employees
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
Body Params
string | null
required

First name.

string | null
required

Last name.

string | null

Middle name.

string | null

Nickname.

int32
enum
required

Type of the employee.

Members:

  • 0 - Employee ( Employee )
  • 1 - Contractor ( Contractor )

Allowed:
string | null

Employee's SSN or contractor's FEIN depending on 'EmployeeType' value. Value in the property is required for US country. This value can't be changed later!

string | null

Employee's Identification ID value. Value in the property is required for country other than US. This value can't be changed later!

date-time | null
required

Date of birth. Value in the property is required when the property will be used in the input object. Data type is validated and must be Number

date-time | null

Hire date. Data type is validated and must be Number

string | null

Personal email.

string | null

Work email.

string | null

Personal phone.

string | null

Cell phone.

string | null

Work phone.

string | null

Work Cell phone.

residentialAddress
object
contract
object

Contract create record.

payAllocation
array of objects | null

Net pay detail.

payAllocation
login
object

New login access level and password.

string | null

Meta data.

string | null

Country.

int32
enum

Members:

  • 1 - USCitizen ( USCitizen. )
  • 2 - PernamentResident ( PernamentResident. )
  • 3 - ResidentAlien ( ResidentAlien. )
  • 4 - NonResidentAlien ( NonResidentAlien. )
Allowed:
string | null

CitizenshipCountry.

string | null

Bio.

int32
enum

Members:

  • 1 - Female ( Female. )
  • 2 - Male ( Male. )
  • 3 - Other ( Other. )
Allowed:
int32 | null

Gender Identity Id

int32
enum

Members:

  • 1 - HeHimHis ( HeHimHis. )
  • 2 - TheThemTheirs ( TheThemTheirs. )
  • 3 - ZeHirHirs ( ZeHirHirs. )
  • 4 - ZeZirZirs ( ZeZirZirs. )
  • 5 - SheHerHers ( SheHerHers. )
  • 6 - Other ( Other. )
  • 7 - PreferNotToAnswer ( PreferNotToAnswer. )
Allowed:
eeo
object
driverLicence
object

Employee's Driver's License.

int32
enum

Members:

  • 1 - Single ( Single. )
  • 2 - Married ( Married. )
  • 3 - Separated ( Separated. )
  • 4 - DivorcedOrWidowed ( Divorced or Widowed. )
Allowed:
int32 | null
≥ 0

Employee UI ID (aka Employee Number).

string | null

Job Description.

Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 days ago

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

Updated 2 days ago