v1
Personnel
Personnel

Onboard Personnel

Create personnel record + WorkOS user + local users row in one atomic flow.

Requires personnel write permission. Rolls back the personnel record if any subsequent step fails.

post/api/v1/personnel/onboard

Request

  • Base URL: https://api.jeevyfabrication.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.jeevyfabrication.com/api/v1/personnel/onboard
  • Auth: none declared

Request body

namestring required
emailstring nullable
phonestring nullable
hire_datestring nullable
statusstring
employee_typestring
shop_idinteger nullable
capability_idsinteger[]
shop_role_idinteger nullable
send_inviteboolean
confirmboolean
pinstring nullable
export_authorization'us_person' | 'foreign_person' nullable
gusto_idstring nullable
addressstring nullable
hourly_ratenumber nullable
emergency_contact_namestring nullable
emergency_contact_phonestring nullable
notesstring nullable
preferred_languagestring nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.