Skip to main content
GET
Get Employee

Authorizations

Authorization
string
header
required

Bearer token for authentication

Path Parameters

employee_id
string
required

Twine specific Employee UUID

Query Parameters

relations
enum<string>[]

Relations to select for Employee Parameters for Employee relations selection.

Available options:
employee_mappings,
organizational_unit_mappings
select
enum<string>[]

Select fields for Employee Parameters for Employee field selection. The actual type of properties.custom_properties will vary depending on your usage.

Note: id and org_id are always returned.

Available options:
id,
org_id,
updated_at,
inserted_at,
properties,
properties.source_external_id,
properties.source_external_manager_id,
properties.source_organizational_unit_external_ids,
properties.active_status,
properties.username,
properties.birthdate,
properties.personal_id_number,
properties.ssn,
properties.nationality,
properties.first_name,
properties.last_name,
properties.middle_name,
properties.honorific_prefix,
properties.honorific_suffix,
properties.full_name,
properties.display_name,
properties.gender,
properties.child_first_name,
properties.child_last_name,
properties.child_birthdate,
properties.email1,
properties.email2,
properties.email3,
properties.phone1,
properties.phone2,
properties.phone3,
properties.phone4,
properties.address_1_line_1,
properties.address_1_line_2,
properties.address_1_line_3,
properties.address_1_postal_code,
properties.address_1_city,
properties.address_1_state,
properties.address_1_country,
properties.address_1_country_iso,
properties.address_2_line_1,
properties.address_2_line_2,
properties.address_2_line_3,
properties.address_2_postal_code,
properties.address_2_city,
properties.address_2_state,
properties.address_2_country,
properties.address_2_country_iso,
properties.tax_table_nr,
properties.tax_table_column,
properties.bank_name,
properties.bank_account_nr,
properties.bank_clearing_nr,
properties.bank_country_iso,
properties.bank_swift,
properties.bank_iban,
properties.bank_bic,
properties.employee_no,
properties.department_id,
properties.department_name,
properties.division_id,
properties.division_name,
properties.team_id,
properties.team_name,
properties.office_id,
properties.office_name,
properties.location_id,
properties.location_name,
properties.company_id,
properties.company_name,
properties.legal_entity_id,
properties.next_of_kin_full_name,
properties.next_of_kin_first_name,
properties.next_of_kin_last_name,
properties.next_of_kin_email,
properties.next_of_kin_phone,
properties.next_of_kin_relationship,
properties.legal_entity_name,
properties.lead_in_unit_id,
properties.org_unit_id,
properties.org_unit_name,
properties.org_unit_type,
properties.cost_center_1,
properties.cost_center_2,
properties.cost_center_1_weight,
properties.cost_center_2_weight,
properties.manager_id,
properties.manager_first_name,
properties.manager_last_name,
properties.manager_full_name,
properties.manager_email1,
properties.manager_email2,
properties.subordinate_id,
properties.is_manager,
properties.salary_amount,
properties.salary_currency,
properties.salary_type_name,
properties.salary_type_id,
properties.salary_payout_day,
properties.salary_period,
properties.salary_payout_frequency,
properties.salary_payout_schedule,
properties.variable_pay_amount,
properties.variable_pay_currency,
properties.variable_pay_type,
properties.variable_pay_type_name,
properties.variable_pay_period,
properties.variable_pay_payout_frequency,
properties.employment_start_date,
properties.employment_hire_date,
properties.employment_leave_date,
properties.position_id,
properties.position_code,
properties.position_name,
properties.employment_probation_end_date,
properties.employment_type_id,
properties.employment_type_name,
properties.employment_tenure_name,
properties.employment_category_id,
properties.employment_category_name,
properties.employment_rate,
properties.employment_weekly_hours,
properties.employment_fte_weekly_hours,
properties.employment_terminated,
properties.employment_termination_reason,
properties.employment_termination_date,
properties.custom_properties,
properties.has_remote_entity
select_by_mapping
string

Select mapped fields by SystemIntegration ID. Specify "all" to aggregate all mappings defined in your organization. Overrides select. Note: id and org_id are always returned.

Response

Employee Response

An employee

data
Employee · object

An employee object