get https://{subdomain}.workable.com/spi/v3/employee_fields
Returns a collection of your account employee_fields. Required scope: r_account.
Log in to see full request history
This particular endpoint utilizes the
r_accountscope, which can be enabled through the Integrations section found within the Settings menu.
Results
Calling the /employee_fields endpoint will return a collection of the defined employee_fields for the account. An example result with all available options follows:
[
{
"id": "firstname",
"label": "First name",
"hint": null,
"type": "text",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": false,
"is_multiple": false
},
{
"id": "middle_name",
"label": "Middle name",
"hint": null,
"type": "text",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": false,
"is_multiple": false
},
{
"id": "lastname",
"label": "Last name",
"hint": null,
"type": "text",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": false,
"is_multiple": false
},
{
"id": "employee_number",
"label": "Employee ID",
"hint": null,
"type": "text",
"editable_by": "admin",
"viewable_by": "all",
"keep_history": false,
"is_multiple": false,
"autogenerate": true
},
{
"id": "preferred_name",
"label": "Preferred name",
"hint": null,
"type": "text",
"editable_by": "employee",
"viewable_by": "all",
"keep_history": false,
"is_multiple": false
},
{
"id": "status",
"label": "Status",
"hint": null,
"type": "dropdown",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "employee",
"choices": [
{
"id": "status_active",
"employee_field_id": 66911,
"label": "Active",
"position": 0
},
{
"id": "status_draft",
"employee_field_id": 66911,
"label": "Draft",
"position": 1
},
{
"id": "status_inactive",
"employee_field_id": 66911,
"label": "Inactive",
"position": 2
}
],
"keep_history": true,
"is_multiple": false
},
{
"id": "country",
"label": "Country",
"hint": null,
"type": "country",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": true,
"is_multiple": false
},
{
"id": "address",
"label": "Address",
"hint": null,
"type": "location",
"editable_by": "employee",
"viewable_by": "employee",
"keep_history": true,
"is_multiple": false
},
{
"id": "gender",
"label": "Gender",
"hint": null,
"type": "dropdown",
"editable_by": "employee",
"viewable_by": "employee",
"choices": [
{
"id": "gender_male",
"employee_field_id": 66914,
"label": "Male",
"position": 0
},
{
"id": "gender_female",
"employee_field_id": 66914,
"label": "Female",
"position": 1
},
{
"id": "gender_non_binary",
"employee_field_id": 66914,
"label": "Non-binary",
"position": 2
}
],
"keep_history": false,
"is_multiple": false
},
{
"id": "marital_status_group",
"label": "Marital status",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "marital_status",
"label": "Status",
"hint": null,
"type": "dropdown",
"position": 0,
"choices": [
{
"id": "marital_status_single",
"employee_field_id": 66962,
"label": "Single",
"position": 0
},
{
"id": "marital_status_married",
"employee_field_id": 66962,
"label": "Married",
"position": 1
},
{
"id": "marital_status_common_law",
"employee_field_id": 66962,
"label": "Common Law",
"position": 2
},
{
"id": "marital_status_domestic_partnership",
"employee_field_id": 66962,
"label": "Domestic Partnership",
"position": 3
}
]
},
{
"id": "marital_status_certificate",
"label": "Certificate",
"hint": null,
"type": "file",
"position": 1
}
],
"keep_history": true,
"is_multiple": false
},
{
"id": "birthdate",
"label": "Birthdate",
"hint": null,
"type": "date",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": false,
"is_multiple": false,
"date_format": "fullDate"
},
{
"id": "phone_group",
"label": "Phone",
"hint": null,
"type": "composite",
"editable_by": "employee",
"viewable_by": "all",
"subfields": [
{
"id": "phone_type",
"label": "Type",
"hint": null,
"type": "dropdown",
"position": 0,
"choices": [
{
"id": "phone_type_work",
"employee_field_id": 66964,
"label": "Work",
"position": 0
},
{
"id": "phone_type_mobile",
"employee_field_id": 66964,
"label": "Mobile",
"position": 1
},
{
"id": "phone_type_home",
"employee_field_id": 66964,
"label": "Home",
"position": 2
},
{
"id": "phone_type_other",
"employee_field_id": 66964,
"label": "Other",
"position": 3
}
]
},
{
"id": "phone",
"label": "Phone",
"hint": null,
"type": "phone",
"position": 1
},
{
"id": "phone_ext",
"label": "Extension",
"hint": null,
"type": "numeric",
"position": 2
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "chat_group",
"label": "Chat & video call",
"hint": null,
"type": "composite",
"editable_by": "employee",
"viewable_by": "all",
"subfields": [
{
"id": "chat_type",
"label": "Type",
"hint": null,
"type": "dropdown",
"position": 0,
"choices": [
{
"id": "chat_type_skype",
"employee_field_id": 66967,
"label": "Skype",
"position": 0
},
{
"id": "chat_type_zoom",
"employee_field_id": 66967,
"label": "Zoom",
"position": 1
},
{
"id": "chat_type_whatsapp",
"employee_field_id": 66967,
"label": "WhatsApp",
"position": 2
},
{
"id": "chat_type_messenger",
"employee_field_id": 66967,
"label": "Messenger",
"position": 3
},
{
"id": "chat_type_google_meet",
"employee_field_id": 66967,
"label": "Google meet",
"position": 4
},
{
"id": "chat_type_slack",
"employee_field_id": 66967,
"label": "Slack",
"position": 5
}
]
},
{
"id": "chat_username",
"label": "Username",
"hint": null,
"type": "text",
"position": 1
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "work_email",
"label": "Work email",
"hint": null,
"type": "email",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": false
},
{
"id": "personal_email",
"label": "Personal email",
"hint": null,
"type": "email",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": true,
"is_multiple": true
},
{
"id": "email_group",
"label": "Email",
"hint": null,
"type": "composite",
"editable_by": "employee",
"viewable_by": "all",
"subfields": [
{
"id": "email_type",
"label": "Type",
"hint": null,
"type": "dropdown",
"position": 0,
"choices": [
{
"id": "email_type_personal",
"employee_field_id": 66969,
"label": "Personal",
"position": 0
},
{
"id": "email_type_work",
"employee_field_id": 66969,
"label": "Work",
"position": 1
},
{
"id": "email_type_other",
"employee_field_id": 66969,
"label": "Other",
"position": 2
}
]
},
{
"id": "email",
"label": "Email",
"hint": null,
"type": "email",
"position": 1
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "social_group",
"label": "Social media",
"hint": null,
"type": "composite",
"editable_by": "employee",
"viewable_by": "all",
"subfields": [
{
"id": "social_type",
"label": "Type",
"hint": null,
"type": "dropdown",
"position": 0,
"choices": [
{
"id": "social_type_facebook",
"employee_field_id": 66971,
"label": "Facebook",
"position": 0
},
{
"id": "social_type_twitter",
"employee_field_id": 66971,
"label": "Twitter",
"position": 1
},
{
"id": "social_type_linkedin",
"employee_field_id": 66971,
"label": "LinkedIn",
"position": 2
}
]
},
{
"id": "social_url",
"label": "URL",
"hint": null,
"type": "text",
"position": 1
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "allergies",
"label": "Allergies",
"hint": null,
"type": "text",
"editable_by": "employee",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": true
},
{
"id": "dietary_restrictions",
"label": "Dietary restrictions",
"hint": null,
"type": "text",
"editable_by": "employee",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": true
},
{
"id": "garment_size_group",
"label": "Clothing size",
"hint": null,
"type": "composite",
"editable_by": "employee",
"viewable_by": "employee",
"subfields": [
{
"id": "garment_size_type",
"label": "Clothing type",
"hint": null,
"type": "dropdown",
"position": 0,
"choices": [
{
"id": "garment_type_shirt",
"employee_field_id": 66973,
"label": "shirt",
"position": 0
},
{
"id": "garment_type_t_shirt",
"employee_field_id": 66973,
"label": "t-shirt",
"position": 1
},
{
"id": "garment_type_jacket",
"employee_field_id": 66973,
"label": "jacket",
"position": 2
}
]
},
{
"id": "garment_size",
"label": "Size",
"hint": null,
"type": "text",
"position": 1
}
],
"keep_history": false,
"is_multiple": true
},
{
"id": "job_title",
"label": "Job title",
"hint": null,
"type": "text",
"editable_by": "manager",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": true,
"is_multiple": false
},
{
"id": "hire_date",
"label": "Hire date",
"hint": null,
"type": "date",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": false,
"date_format": "fullDate"
},
{
"id": "start_date",
"label": "Start date",
"hint": null,
"type": "date",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": false,
"is_multiple": false,
"date_format": "fullDate"
},
{
"id": "legal_entity",
"label": "Entity",
"hint": null,
"type": "legalEntity",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": true,
"is_multiple": false
},
{
"id": "department",
"label": "Department",
"hint": null,
"type": "department",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": true,
"is_multiple": false
},
{
"id": "division",
"label": "Division",
"hint": null,
"type": "dropdown",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "all",
"choices": [],
"keep_history": true,
"is_multiple": false
},
{
"id": "team",
"label": "Team",
"hint": null,
"type": "dropdown",
"editable_by": "manager",
"approvable_by": "admin",
"viewable_by": "all",
"choices": [],
"keep_history": true,
"is_multiple": false
},
{
"id": "reports_to",
"label": "Manager",
"hint": null,
"type": "employee",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "all",
"keep_history": true,
"is_multiple": false
},
{
"id": "direct_reports",
"label": "Direct reports",
"hint": null,
"type": "directReports",
"editable_by": "admin",
"viewable_by": "all",
"keep_history": false,
"is_multiple": false
},
{
"id": "notice_period",
"label": "Notice period in days",
"hint": null,
"type": "numeric",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": false
},
{
"id": "probation_group",
"label": "Probation",
"hint": null,
"type": "composite",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "probation_start_date",
"label": "Start date",
"hint": null,
"type": "date",
"position": 0,
"date_format": "fullDate"
},
{
"id": "probation_end_date",
"label": "End date",
"hint": null,
"type": "date",
"position": 1,
"date_format": "fullDate"
},
{
"id": "probation_note",
"label": "Note",
"hint": null,
"type": "text",
"position": 2
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "employment_group",
"label": "Contract details",
"hint": null,
"type": "composite",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "employment_effective_date",
"label": "Effective date",
"hint": null,
"type": "date",
"position": 0,
"date_format": "fullDate"
},
{
"id": "employment_status",
"label": "Employment type",
"hint": null,
"type": "dropdown",
"position": 1,
"choices": [
{
"id": "employement_type_contractor",
"employee_field_id": 66979,
"label": "Contractor",
"position": 0
},
{
"id": "employement_type_full_time",
"employee_field_id": 66979,
"label": "Full-Time",
"position": 1
},
{
"id": "employement_type_part_time",
"employee_field_id": 66979,
"label": "Part-Time",
"position": 2
}
]
},
{
"id": "employment_work_place",
"label": "Workplace",
"hint": null,
"type": "dropdown",
"position": 2,
"choices": [
{
"id": "employment_work_place_onsite",
"employee_field_id": 66980,
"label": "Onsite",
"position": 0
},
{
"id": "employment_work_place_remote",
"employee_field_id": 66980,
"label": "Remote",
"position": 1
},
{
"id": "employment_work_place_hybrid",
"employee_field_id": 66980,
"label": "Hybrid",
"position": 2
}
]
},
{
"id": "employment_working_hours",
"label": "Work hours",
"hint": null,
"type": "timetable",
"position": 3
},
{
"id": "employment_total_hours_per_week",
"label": "Total hours per week",
"hint": null,
"type": "numeric",
"position": 4
},
{
"id": "employment_expiry_date",
"label": "Expiry date",
"hint": null,
"type": "date",
"position": 5,
"date_format": "fullDate"
},
{
"id": "employment_note",
"label": "Note",
"hint": null,
"type": "text",
"position": 6
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "work_schedule",
"label": "Work schedule",
"hint": null,
"type": "workSchedule",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": false
},
{
"id": "salary_group",
"label": "Salary details",
"hint": null,
"type": "composite",
"editable_by": "manager",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "salary_effective_date",
"label": "Effective date",
"hint": null,
"type": "date",
"position": 0,
"date_format": "fullDate"
},
{
"id": "salary_pay_type",
"label": "Pay type",
"hint": null,
"type": "dropdown",
"position": 1,
"choices": [
{
"id": "salary_pay_type_salary",
"employee_field_id": 66986,
"label": "Salary",
"position": 0
},
{
"id": "salary_pay_type_hourly",
"employee_field_id": 66986,
"label": "Hourly",
"position": 1
},
{
"id": "salary_pay_type_commission_only",
"employee_field_id": 66986,
"label": "Commission Only",
"position": 2
}
]
},
{
"id": "salary_pay_rate",
"label": "Pay rate",
"hint": null,
"type": "payRate",
"position": 2
},
{
"id": "salary_pay_schedule",
"label": "Pay schedule",
"hint": null,
"type": "dropdown",
"position": 3,
"choices": [
{
"id": "salary_pay_schedule_monthly",
"employee_field_id": 66988,
"label": "Monthly",
"position": 0
},
{
"id": "salary_pay_schedule_every_15_days",
"employee_field_id": 66988,
"label": "Every 15 days",
"position": 1
},
{
"id": "salary_pay_schedule_annually",
"employee_field_id": 66988,
"label": "Annually",
"position": 2
},
{
"id": "salary_pay_schedule_weekly",
"employee_field_id": 66988,
"label": "Weekly",
"position": 3
},
{
"id": "salary_pay_schedule_daily",
"employee_field_id": 66988,
"label": "Daily",
"position": 4
}
]
},
{
"id": "salary_overtime_status",
"label": "Overtime status",
"hint": null,
"type": "dropdown",
"position": 4,
"choices": [
{
"id": "salary_overtime_status_exempt",
"employee_field_id": 66989,
"label": "Exempt",
"position": 0
},
{
"id": "salary_overtime_status_non_exempt",
"employee_field_id": 66989,
"label": "Non-exempt",
"position": 1
}
]
},
{
"id": "salary_justification",
"label": "Reason",
"hint": null,
"type": "dropdown",
"position": 5,
"choices": [
{
"id": "salary_justification_new_hire",
"employee_field_id": 66990,
"label": "New Hire",
"position": 0
},
{
"id": "salary_justification_adjustment",
"employee_field_id": 66990,
"label": "Adjustment",
"position": 1
},
{
"id": "salary_justification_new_role",
"employee_field_id": 66990,
"label": "New Role",
"position": 2
},
{
"id": "salary_justification_promotion",
"employee_field_id": 66990,
"label": "Promotion",
"position": 3
},
{
"id": "salary_justification_other",
"employee_field_id": 66990,
"label": "Other",
"position": 4
}
]
},
{
"id": "salary_note",
"label": "Note",
"hint": null,
"type": "text",
"position": 6
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "commission_group",
"label": "Commission details",
"hint": null,
"type": "composite",
"editable_by": "manager",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "commission_percentage",
"label": "Commission %",
"hint": null,
"type": "percentage",
"position": 0
},
{
"id": "commission_tier",
"label": "Tier",
"hint": null,
"type": "numeric",
"position": 1
},
{
"id": "commission_effective_date",
"label": "Effective date",
"hint": null,
"type": "date",
"position": 2,
"date_format": "fullDate"
},
{
"id": "commission_pay_schedule",
"label": "Pay schedule",
"hint": null,
"type": "dropdown",
"position": 3,
"choices": [
{
"id": "commission_pay_schedule_montly",
"employee_field_id": 66995,
"label": "Monthly",
"position": 0
},
{
"id": "commission_pay_schedule_every_15_days",
"employee_field_id": 66995,
"label": "Every 15 days",
"position": 1
},
{
"id": "commission_pay_schedule_annually",
"employee_field_id": 66995,
"label": "Annually",
"position": 2
},
{
"id": "commission_pay_schedule_weekly",
"employee_field_id": 66995,
"label": "Weekly",
"position": 3
},
{
"id": "commission_pay_schedule_daily",
"employee_field_id": 66995,
"label": "Daily",
"position": 4
}
]
},
{
"id": "commission_reason",
"label": "Reason",
"hint": null,
"type": "dropdown",
"position": 4,
"choices": []
},
{
"id": "commission_note",
"label": "Note",
"hint": null,
"type": "text",
"position": 5
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "bonus_group",
"label": "Bonus details",
"hint": null,
"type": "composite",
"editable_by": "manager",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "bonus_amount",
"label": "Amount",
"hint": null,
"type": "currency",
"position": 0
},
{
"id": "bonus_salary_percentage",
"label": "Salary %",
"hint": null,
"type": "percentage",
"position": 1
},
{
"id": "bonus_effective_date",
"label": "Effective date",
"hint": null,
"type": "date",
"position": 2,
"date_format": "fullDate"
},
{
"id": "bonus_pay_schedule",
"label": "Pay schedule",
"hint": null,
"type": "dropdown",
"position": 3,
"choices": [
{
"id": "bonus_pay_schedule_monthly",
"employee_field_id": 67001,
"label": "Monthly",
"position": 0
},
{
"id": "bonus_pay_schedule_every_15_days",
"employee_field_id": 67001,
"label": "Every 15 days",
"position": 1
},
{
"id": "bonus_pay_schedule_annually",
"employee_field_id": 67001,
"label": "Annually",
"position": 2
},
{
"id": "bonus_pay_schedule_weekly",
"employee_field_id": 67001,
"label": "Weekly",
"position": 3
},
{
"id": "bonus_pay_schedule_daily",
"employee_field_id": 67001,
"label": "Daily",
"position": 4
}
]
},
{
"id": "bonus_reason",
"label": "Reason",
"hint": null,
"type": "dropdown",
"position": 4,
"choices": []
},
{
"id": "bonus_note",
"label": "Note",
"hint": null,
"type": "text",
"position": 5
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "stock_options_group",
"label": "Stock options",
"hint": null,
"type": "composite",
"editable_by": "manager",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "stock_options_price",
"label": "Stock option price",
"hint": null,
"type": "currency",
"position": 0
},
{
"id": "stock_options_grant_date",
"label": "Grant date",
"hint": null,
"type": "date",
"position": 1,
"date_format": "fullDate"
},
{
"id": "stock_options_vesting_date",
"label": "Vesting date",
"hint": null,
"type": "date",
"position": 2,
"date_format": "fullDate"
},
{
"id": "stock_options_plan",
"label": "Plan",
"hint": null,
"type": "dropdown",
"position": 3,
"choices": []
},
{
"id": "stock_options_note",
"label": "Note",
"hint": null,
"type": "text",
"position": 4
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "assets_group",
"label": "Asset details",
"hint": null,
"type": "composite",
"editable_by": "manager",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "assets_name",
"label": "Asset name",
"hint": null,
"type": "text",
"position": 0
},
{
"id": "assets_grant_date",
"label": "Issue date",
"hint": null,
"type": "date",
"position": 1,
"date_format": "fullDate"
},
{
"id": "assets_expiry_date",
"label": "Expiry date",
"hint": null,
"type": "date",
"position": 2,
"date_format": "fullDate"
},
{
"id": "assets_note",
"label": "Note",
"hint": null,
"type": "text",
"position": 3
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "credit_card_group",
"label": "Card details",
"hint": null,
"type": "composite",
"editable_by": "manager",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "credit_card_number",
"label": "Card number (last 4 digits)",
"hint": null,
"type": "text",
"position": 0
},
{
"id": "credit_card_type",
"label": "Card type",
"hint": null,
"type": "dropdown",
"position": 1,
"choices": [
{
"id": "credit_card_type_visa",
"employee_field_id": 67014,
"label": "Visa",
"position": 0
},
{
"id": "credit_card_type_mastercard",
"employee_field_id": 67014,
"label": "Mastercard",
"position": 1
},
{
"id": "credit_card_type_amex",
"employee_field_id": 67014,
"label": "Amex",
"position": 2
}
]
},
{
"id": "credit_card_expiration_date",
"label": "Expiry date",
"hint": null,
"type": "date",
"position": 2,
"date_format": "fullDate"
},
{
"id": "credit_card_cardholder",
"label": "Cardholder name",
"hint": null,
"type": "text",
"position": 3
},
{
"id": "credit_card_grant_date",
"label": "Issue date",
"hint": null,
"type": "date",
"position": 4,
"date_format": "fullDate"
},
{
"id": "credit_card_note",
"label": "Note",
"hint": null,
"type": "text",
"position": 5
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "bank_details_group",
"label": "Bank details",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "bank_details_bank_name",
"label": "Bank name",
"hint": null,
"type": "text",
"position": 0
},
{
"id": "bank_details_iban",
"label": "IBAN",
"hint": null,
"type": "text",
"position": 1
},
{
"id": "bank_details_account_number",
"label": "Account number",
"hint": null,
"type": "text",
"position": 2
},
{
"id": "bank_details_bic",
"label": "BIC (SWIFT)",
"hint": null,
"type": "text",
"position": 3
},
{
"id": "bank_details_transit_number",
"label": "ABA/Transit number",
"hint": null,
"type": "text",
"position": 4
},
{
"id": "bank_details_bank_state_branch",
"label": "Bank State Branch (BSB)",
"hint": null,
"type": "text",
"position": 5
},
{
"id": "bank_details_routing_number",
"label": "Routing number",
"hint": null,
"type": "text",
"position": 6
},
{
"id": "bank_details_sort_code",
"label": "Sort code",
"hint": null,
"type": "text",
"position": 7
}
],
"keep_history": true,
"is_multiple": false
},
{
"id": "social_security_number_group",
"label": "Social security number",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "social_security_number_number",
"label": "Number",
"hint": null,
"type": "text",
"position": 0
},
{
"id": "social_security_number_issue_date",
"label": "Issue date",
"hint": null,
"type": "date",
"position": 1,
"date_format": "fullDate"
},
{
"id": "social_security_number_file",
"label": "File",
"hint": null,
"type": "file",
"position": 2
}
],
"keep_history": true,
"is_multiple": false
},
{
"id": "national_identification_number_group",
"label": "National identification number",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "national_identification_number_number",
"label": "Number",
"hint": null,
"type": "text",
"position": 0
},
{
"id": "national_identification_number_issue_date",
"label": "Issue date",
"hint": null,
"type": "date",
"position": 1,
"date_format": "fullDate"
},
{
"id": "national_identification_number_file",
"label": "File",
"hint": null,
"type": "file",
"position": 2
}
],
"keep_history": true,
"is_multiple": false
},
{
"id": "social_insurance_number_group",
"label": "Social insurance number",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "social_insurance_number_number",
"label": "Number",
"hint": null,
"type": "text",
"position": 0
},
{
"id": "social_insurance_number_issue_date",
"label": "Issue date",
"hint": null,
"type": "date",
"position": 1,
"date_format": "fullDate"
},
{
"id": "social_insurance_number_insurance_carrier",
"label": "Insurance carrier",
"hint": null,
"type": "dropdown",
"position": 2,
"choices": []
},
{
"id": "social_insurance_number_file",
"label": "File",
"hint": null,
"type": "file",
"position": 3
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "tax_identification_number_group",
"label": "Tax identification number",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "tax_identification_number_number",
"label": "Number",
"hint": null,
"type": "text",
"position": 0
},
{
"id": "tax_identification_number_issue_date",
"label": "Issue date",
"hint": null,
"type": "date",
"position": 1,
"date_format": "fullDate"
},
{
"id": "tax_identification_number_file",
"label": "File",
"hint": null,
"type": "file",
"position": 2
}
],
"keep_history": true,
"is_multiple": false
},
{
"id": "nationality",
"label": "Nationality",
"hint": null,
"type": "country",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": false
},
{
"id": "birthPlace",
"label": "Birthplace",
"hint": null,
"type": "location",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": false
},
{
"id": "citizenship",
"label": "Citizenship",
"hint": null,
"type": "country",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": true
},
{
"id": "passport_group",
"label": "Passport details",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "passport_country",
"label": "Country",
"hint": null,
"type": "country",
"position": 0
},
{
"id": "passport_number",
"label": "Number",
"hint": null,
"type": "text",
"position": 1
},
{
"id": "passport_issue_date",
"label": "Issue date",
"hint": null,
"type": "date",
"position": 2,
"date_format": "fullDate"
},
{
"id": "passport_expiration_date",
"label": "Expiry date",
"hint": null,
"type": "date",
"position": 3,
"date_format": "fullDate"
},
{
"id": "passport_attachment",
"label": "File",
"hint": null,
"type": "file",
"position": 4
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "visa_group",
"label": "Visa details",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "visa_country",
"label": "Country",
"hint": null,
"type": "country",
"position": 0
},
{
"id": "visa_type",
"label": "Type",
"hint": null,
"type": "dropdown",
"position": 1,
"choices": []
},
{
"id": "visa_number",
"label": "Number",
"hint": null,
"type": "text",
"position": 2
},
{
"id": "visa_issue_date",
"label": "Issue date",
"hint": null,
"type": "date",
"position": 3,
"date_format": "fullDate"
},
{
"id": "visa_expiration_date",
"label": "Expiry date",
"hint": null,
"type": "date",
"position": 4,
"date_format": "fullDate"
},
{
"id": "visa_attachment",
"label": "File",
"hint": null,
"type": "file",
"position": 5
}
],
"keep_history": true,
"is_multiple": true
},
{
"id": "driver_license_group",
"label": "License details",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "driver_license_country",
"label": "Country",
"hint": null,
"type": "country",
"position": 0
},
{
"id": "driver_license_state",
"label": "State",
"hint": null,
"type": "text",
"position": 1
},
{
"id": "driver_license_number",
"label": "Number",
"hint": null,
"type": "text",
"position": 2
},
{
"id": "driver_license_class",
"label": "Class",
"hint": null,
"type": "text",
"position": 3
},
{
"id": "driver_license_issue_date",
"label": "Issue date",
"hint": null,
"type": "date",
"position": 4,
"date_format": "fullDate"
},
{
"id": "driver_license_expiration_date",
"label": "Expiry date",
"hint": null,
"type": "date",
"position": 5,
"date_format": "fullDate"
},
{
"id": "driver_license_attachment",
"label": "File",
"hint": null,
"type": "file",
"position": 6
}
],
"keep_history": false,
"is_multiple": true
},
{
"id": "education_group",
"label": "Education details",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "education_start_date",
"label": "Start date",
"hint": null,
"type": "date",
"position": 0,
"date_format": "monthYear"
},
{
"id": "education_end_date",
"label": "End date",
"hint": null,
"type": "date",
"position": 1,
"date_format": "monthYear"
},
{
"id": "education_degree",
"label": "Degree",
"hint": null,
"type": "text",
"position": 2
},
{
"id": "education_field_of_study",
"label": "Field of study",
"hint": null,
"type": "text",
"position": 3
},
{
"id": "education_school",
"label": "School",
"hint": null,
"type": "text",
"position": 4
}
],
"keep_history": false,
"is_multiple": true
},
{
"id": "work_experience_group",
"label": "Job details",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "work_experience_start_date",
"label": "Start date",
"hint": null,
"type": "date",
"position": 0,
"date_format": "monthYear"
},
{
"id": "work_experience_end_date",
"label": "End date",
"hint": null,
"type": "date",
"position": 1,
"date_format": "monthYear"
},
{
"id": "work_experience_job_title",
"label": "Job title",
"hint": null,
"type": "text",
"position": 2
},
{
"id": "work_experience_company",
"label": "Company",
"hint": null,
"type": "text",
"position": 3
},
{
"id": "work_experience_summary",
"label": "Summary",
"hint": null,
"type": "paragraph",
"position": 4
},
{
"id": "work_experience_present",
"label": "Present",
"hint": null,
"type": "boolean",
"position": 5
}
],
"keep_history": false,
"is_multiple": true
},
{
"id": "skills",
"label": "Skill",
"hint": null,
"type": "text",
"editable_by": "employee",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": true
},
{
"id": "language",
"label": "Language",
"hint": null,
"type": "text",
"editable_by": "employee",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": true
},
{
"id": "resume",
"label": "File",
"hint": null,
"type": "file",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"keep_history": false,
"is_multiple": false
},
{
"id": "1195b",
"label": "Custom contact field",
"hint": null,
"type": "composite",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "1195c",
"label": "Custom contact field dropdown",
"hint": "Hint for custom contact field dropdown",
"type": "dropdown",
"position": 0,
"choices": [
{
"id": "7f62",
"employee_field_id": 70794,
"label": "Custom choice 1",
"position": 0
},
{
"id": "7f63",
"employee_field_id": 70794,
"label": "Custom choice 2",
"position": 1
},
{
"id": "7f64",
"employee_field_id": 70794,
"label": "Custom choice 3",
"position": 2
}
]
},
{
"id": "1195d",
"label": "Custom contact field",
"hint": "Hint for custom contact field",
"type": "text",
"position": 1
}
],
"keep_history": false,
"is_multiple": true
},
{
"id": "contact_group",
"label": "Contact details",
"hint": null,
"type": "composite",
"editable_by": "employee",
"viewable_by": "employee",
"subfields": [
{
"id": "contact_name",
"label": "Name",
"hint": null,
"type": "text",
"position": 0
},
{
"id": "contact_relationship",
"label": "Relationship",
"hint": null,
"type": "dropdown",
"position": 1,
"choices": [
{
"id": "contact_relationship_type_husband",
"employee_field_id": 67070,
"label": "Husband",
"position": 0
},
{
"id": "contact_relationship_type_wife",
"employee_field_id": 67070,
"label": "Wife",
"position": 1
},
{
"id": "contact_relationship_type_partner",
"employee_field_id": 67070,
"label": "Partner",
"position": 2
},
{
"id": "contact_relationship_type_mother",
"employee_field_id": 67070,
"label": "Mother",
"position": 3
},
{
"id": "contact_relationship_type_father",
"employee_field_id": 67070,
"label": "Father",
"position": 4
},
{
"id": "contact_relationship_type_brother",
"employee_field_id": 67070,
"label": "Brother",
"position": 5
},
{
"id": "contact_relationship_type_sister",
"employee_field_id": 67070,
"label": "Sister",
"position": 6
},
{
"id": "contact_relationship_type_son",
"employee_field_id": 67070,
"label": "Son",
"position": 7
},
{
"id": "contact_relationship_type_daughter",
"employee_field_id": 67070,
"label": "Daughter",
"position": 8
},
{
"id": "contact_relationship_type_friend",
"employee_field_id": 67070,
"label": "Friend",
"position": 9
},
{
"id": "contact_relationship_type_other",
"employee_field_id": 67070,
"label": "Other",
"position": 10
}
]
},
{
"id": "contact_phone",
"label": "Phone",
"hint": null,
"type": "phone",
"position": 2
},
{
"id": "contact_email",
"label": "Email",
"hint": null,
"type": "email",
"position": 3
},
{
"id": "contact_country",
"label": "Country",
"hint": null,
"type": "country",
"position": 4
},
{
"id": "contact_address",
"label": "Address",
"hint": null,
"type": "location",
"position": 5
}
],
"keep_history": false,
"is_multiple": true
}
]
Each employee_field will have the following keys:
| key | type | description |
|---|---|---|
| id | string | The id of the employee field. This is the identifier that should be used when creating/updating employee field values in the POST, PUT actions for employees. Custom fields will have ids as can be seen from the example above, while default fields have the semantic type as id. |
| label | string | The label of the employee field that appears in the user interface |
| hint | string | The hint of the employee field that appears in the user interface |
| type | string | The field type of the employee field. Available values are boolean, composite, country, currency, date, email, file, image, location, numeric, payRate, paragraph, percentage, phone, text, timetable, directReports. |
| editable_by | string | Value that defines the role access level for editing the employee field. Available values are employee, line_manager and admin, from the less to most strict access levels. |
| approvable_by | string | Value that defines the role access level of the approvals workflow for performing changes in an employee field. Available values are none and admin. |
| viewable_by | string | Value that defines the role access level for viewing the employee field. Available values are all,employee, line_manager and admin, from the less to most strict access levels. This relates with the information being available to the GET employee/:id endpoint |
| subfields | array | A subfield is explained below /employee_fields#subfield |
| keep_history | boolean | Value that defines weather we track the historical evolution of this field or not. Example would be the salary of an employee, or the job position, etc. |
| is_multiple | boolean | Value that defines weather we allow multiple entries for the specific employee field. Example would be the Contract Details as can be shown below in the full example. |
| choices | array | A choice field is explained below /employee_fields#choice |
| date_format | string | In case of date employee field type the available date format options are: full_date, month_year. |
Composite
Composite is a special employee_field type structure used for capturing grouped information concerning an employee. An example composite field is the Social Security Number field that is comprised of three subfields:
{
"id": "social_security_number_group",
"label": "Social security number",
"hint": null,
"type": "composite",
"editable_by": "employee",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "social_security_number_number",
"label": "Number",
"hint": null,
"type": "text",
"position": 0
},
{
"id": "social_security_number_issue_date",
"label": "Issue date",
"hint": null,
"type": "date",
"position": 1,
"date_format": "fullDate"
},
{
"id": "social_security_number_file",
"label": "File",
"hint": null,
"type": "file",
"position": 2
}
],
"keep_history": true,
"is_multiple": false
}
Subfield
Subfields are essentially employee fields as part of a composite employee field type. Each subfield will have a subset of keys of an employee_field. Keys like approvable_by, viewable_by and editable_by are inherited by the parent employee_field. Subfields have the addition of the below key:
| key | type | description |
|---|---|---|
| position | integer | Position of the subfield in the composite field structure. Required for keeping the position of display inside the composite field structure. |
Choice
Choices are options for dropdown employee field types. An example for a dropdown and multiselect employee field named status follows:
{
"id": "status",
"label": "Status",
"hint": null,
"type": "dropdown",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "employee",
"choices": [
{
"id": "status_active",
"label": "Active",
"position": 0,
},
{
"id": "status_draft",
"label": "Draft",
"position": 1,
},
{
"id": "status_inactive",
"label": "Inactive",
"position": 2,
}
],
"keep_history": true,
"is_multiple": false
}
Each option has the following keys:
| key | type | description |
|---|---|---|
| id | string | The id of the option for a specific dropdown employee field |
| label | string | The label of the dropdown of the employee field that appears in the user interface |
| position | integer | The position of the option field in the dropdown menu |
Custom fields
Below is the snippet for a custom field response:
{
"id": "1195b",
"label": "Custom contact field",
"hint": null,
"type": "composite",
"editable_by": "admin",
"approvable_by": "admin",
"viewable_by": "employee",
"subfields": [
{
"id": "1195c",
"label": "Custom contact field dropdown",
"hint": "Hint for custom contact field dropdown",
"type": "dropdown",
"position": 0,
"choices": [
{
"id": "7f62",
"label": "Custom choice 1",
"position": 0
},
{
"id": "7f63",
"label": "Custom choice 2",
"position": 1
},
{
"id": "7f64",
"label": "Custom choice 3",
"position": 2
}
]
},
{
"id": "1195d",
"label": "Custom contact field",
"hint": "Hint for custom contact field",
"type": "text",
"position": 1
}
],
"keep_history": false,
"is_multiple": true
}
This is a multi-value (is_multiple is true) composite field with id 1195b and it is comprised of two different subfields, the one with id: 1195c and the one with id: 1195d.
The first subfield is a drop down field, with 3 different values available (7f62, 7f63, 7f64). The second subfield is a text type field. It is important to note these ids as they are used both for displaying the value configured for an employee and for creating programmatically values for these fields.
Responses