Invite an employee

Invite a single employee for the company associated with your API key. Validation is plan-aware: timetracking plans accept a smaller field set and reject payroll-specific fields; payroll/premium plans support all employment types. Swagger request examples are grouped by plan and employment type so you can copy the exact payload profile you need.

Field rules matrix:

  • General required (all types/plans): first_name, last_name, email, employment_type, start_date
  • General optional (all types/plans): middle_name, timetrack_only (defaults false)
  • Timetracking plan employment types: admin, employee (payroll-specific fields and timetrack_only are not accepted)
  • Payroll/Premium plan employment types: admin, employee, contractor (with optional timetrack_only)
  • Admin: same base fields; manager_type is premium-only; timetrack_only not valid
  • Employee (timetrack_only=false): workplace (workplace ID) required + payment_unit required
  • Contractor: same wage branching as employee, but workplace is not required
  • payment_unit=hour: payment_amount required (0 allowed), overtime_amount required (min 1.5), default_hours optional
  • payment_unit=salary: salary_type required, salary required (0 allowed)
  • payment_unit=hourly_salary: requires both hour and salary fields
  • is_i9_form_required: available for employee types on premium plans
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Plan-aware invitation payload. Conditional required fields depend on plan, employment type, and payment_unit.

string
required
string | null
string
required
string
required
string
enum
required

Employment classification for the new employee

Allowed:
boolean
Defaults to false

Whether this employee is excluded from payroll (only valid for employee or contractor types)

date-time
required
integer | null
string | null

Workplace ID (required for payroll employee types)

string | null
enum

Required for employee employment types on payroll/premium plans

Allowed:
number | null
number | null
number | null
string | null
enum
Allowed:
number | null
number | null
number | null
number | null
number | null
boolean | null
string | null
string | null
string | null
string | null
string | null
enum

Premium plans only

Allowed:
Responses

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