HRIS
- Overview
- Use Cases
Common Guides
API Reference
- Companies
- Custom Field Definitions
- Employees
- GETList Employees
- POSTCreates an employee
- GETGet Employee
- PATCHUpdates an employee
- POSTInvite Employee
- Time Off
- Documents
- Work Eligibility
- Time Off Balances
- Employments
- Skills
- Time Off Policies
- GET
- Documents
- Employments
- Locations
- Time Off
- Time Entries
- Benefits
- Groups
- Jobs
- Time Off Policies
Updates an employee
curl --request PATCH \
--url https://api.stackone.com/unified/hris/employees/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '{
"first_name": "Isaac",
"last_name": "Newton",
"name": "Isaac Newton",
"display_name": "Sir Isaac Newton",
"avatar_url": "https://example.com/avatar.png",
"personal_email": "isaac.newton@example.com",
"personal_phone_number": "+1234567890",
"work_email": "newton@example.com",
"work_phone_number": "+1234567890",
"job_id": "R-6789",
"job_title": "Physicist",
"department_id": "3093",
"team_id": "2913",
"department": "Physics",
"manager_id": "67890",
"gender": "male",
"preferred_language": "en_US",
"ethnicity": "white",
"date_of_birth": "1990-01-01T00:00.000Z",
"birthday": "2021-01-01T00:00:00Z",
"marital_status": "single",
"avatar": "https://example.com/avatar.png",
"hire_date": "2021-01-01T00:00.000Z",
"start_date": "2021-01-01T00:00.000Z",
"employment_type": "full_time",
"employment_contract_type": "full_time",
"employment_status": "active",
"termination_date": "2021-01-01T00:00:00Z",
"company_name": "Example Corp",
"company_id": "1234567890",
"citizenships": [
{
"value": "US",
"source_value": "<string>"
}
],
"employment": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"job_title": "Software Engineer",
"pay_rate": "40.00",
"pay_period": "monthly",
"pay_frequency": "hourly",
"pay_currency": "USD",
"effective_date": "2021-01-01T01:01:01.000Z",
"employment_type": "permanent",
"employment_contract_type": "full_time",
"work_time": {
"duration": "P0Y0M0DT8H0M0S",
"duration_unit": "month"
}
},
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
],
"benefits": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Health Insurance",
"benefit_type": {
"value": "retirement_savings",
"source_value": "<string>"
},
"provider": "Aetna",
"description": "Health insurance for employees",
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z"
}
],
"employee_number": "125",
"national_identity_number": {
"value": "123456789",
"type": {
"value": "ssn",
"source_value": "<string>"
},
"country": {
"value": "US",
"source_value": "<string>"
}
},
"national_identity_numbers": [
{
"value": "123456789",
"type": {
"value": "ssn",
"source_value": "<string>"
},
"country": {
"value": "US",
"source_value": "<string>"
}
}
],
"home_location": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Woolsthorpe Manor",
"phone_number": "+44 1476 860 364",
"street_1": "Water Lane",
"street_2": "Woolsthorpe by Colsterworth",
"city": "Grantham",
"zip_code": "NG33 5NR",
"country": {
"value": "US",
"source_value": "<string>"
},
"passthrough": {
"other_known_names": "John Doe"
},
"state": "GB-LIN"
},
"work_location": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Woolsthorpe Manor",
"phone_number": "+44 1476 860 364",
"street_1": "Water Lane",
"street_2": "Woolsthorpe by Colsterworth",
"city": "Grantham",
"zip_code": "NG33 5NR",
"country": {
"value": "US",
"source_value": "<string>"
},
"passthrough": {
"other_known_names": "John Doe"
},
"state": "GB-LIN"
},
"passthrough": {
"other_known_names": "John Doe"
}
}'
{
"statusCode": 200,
"message": "Record updated successfully.",
"timestamp": "2021-01-01T01:01:01.000Z"
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Path Parameters
Body
The employee first name
"Isaac"
The employee last name
"Newton"
The employee name
"Isaac Newton"
The employee display name
"Sir Isaac Newton"
The employee avatar Url
"https://example.com/avatar.png"
The employee personal email
"isaac.newton@example.com"
The employee personal phone number
"+1234567890"
The employee work email
"newton@example.com"
The employee work phone number
"+1234567890"
The employee job id
"R-6789"
The employee job title
"Physicist"
The employee department id
"3093"
The employee team id
"2913"
The employee department
"Physics"
The employee manager ID
"67890"
The employee preferred language
The ISO639-2 Code of the language
aar
, afr
, amh
, ara
, aym
, aze
, bel
, bul
, bis
, ben
, bos
, byn
, cat
, cha
, ces
, deu
, div
, dzo
, ell
, eng
, spa
, est
, fas
, fan
, ful
, fin
, fij
, fao
, fra
, gle
, grn
, glv
, heb
, hin
, hrv
, hat
, hun
, hye
, ind
, isl
, ita
, jpn
, kat
, kon
, kaz
, kal
, khm
, kor
, kur
, kir
, lat
, ltz
, lin
, lao
, lit
, lub
, lav
, mlg
, mah
, mri
, mkd
, msa
, mlt
, mya
, nob
, nep
, nld
, nno
, nor
, nbl
, nya
, pan
, pol
, pus
, por
, rar
, roh
, rup
, ron
, rus
, kin
, sag
, sin
, slk
, smo
, sna
, som
, sqi
, srp
, ssw
, swe
, swa
, tam
, tgk
, tha
, tir
, tig
, zho
, unmapped_value
"eng"
"en_US"
The employee ethnicity
The employee date_of_birth
"1990-01-01T00:00.000Z"
The employee birthday
"2021-01-01T00:00:00Z"
The employee hire date
"2021-01-01T00:00.000Z"
The employee start date
"2021-01-01T00:00.000Z"
The employee employment type
"full_time"
The employee termination date
"2021-01-01T00:00:00Z"
The employee company name
"Example Corp"
The employee company id
"1234567890"
The citizenships of the Employee
The ISO3166-1 Alpha2 Code of the Country
AF
, AL
, DZ
, AS
, AD
, AO
, AI
, AQ
, AG
, AR
, AM
, AW
, AU
, AT
, AZ
, BS
, BH
, BD
, BB
, BY
, BE
, BZ
, BJ
, BM
, BT
, BO
, BQ
, BA
, BW
, BV
, BR
, IO
, BN
, BG
, BF
, BI
, KH
, CM
, CA
, CV
, KY
, CF
, TD
, CL
, CN
, CX
, CC
, CO
, KM
, CG
, CD
, CK
, CR
, HR
, CU
, CW
, CY
, CZ
, CI
, DK
, DJ
, DM
, DO
, EC
, EG
, SV
, GQ
, ER
, EE
, ET
, FK
, FO
, FJ
, FI
, FR
, GF
, PF
, TF
, GA
, GM
, GE
, DE
, GH
, GI
, GR
, GL
, GD
, GP
, GU
, GT
, GG
, GN
, GW
, GY
, HT
, HM
, VA
, HN
, HK
, HU
, IS
, IN
, ID
, IR
, IQ
, IE
, IM
, IL
, IT
, JM
, JP
, JE
, JO
, KZ
, KE
, KI
, KP
, KR
, KW
, KG
, LA
, LV
, LB
, LS
, LR
, LY
, LI
, LT
, LU
, MO
, MK
, MG
, MW
, MY
, MV
, ML
, MT
, MH
, MQ
, MR
, MU
, YT
, MX
, FM
, MD
, MC
, MN
, ME
, MS
, MA
, MZ
, MM
, NA
, NR
, NP
, NL
, NC
, NZ
, NI
, NE
, NG
, NU
, NF
, MP
, NO
, OM
, PK
, PW
, PS
, PA
, PG
, PY
, PE
, PH
, PN
, PL
, PT
, PR
, QA
, RO
, RU
, RW
, RE
, BL
, SH
, KN
, LC
, MF
, PM
, VC
, WS
, SM
, ST
, SA
, SN
, RS
, SC
, SL
, SG
, SX
, SK
, SI
, SB
, SO
, ZA
, GS
, SS
, ES
, LK
, SD
, SR
, SJ
, SZ
, SE
, CH
, SY
, TW
, TJ
, TZ
, TH
, TL
, TG
, TK
, TO
, TT
, TN
, TR
, TM
, TC
, TV
, UG
, UA
, AE
, GB
, US
, UM
, UY
, UZ
, VU
, VE
, VN
, VG
, VI
, WF
, EH
, YE
, ZM
, ZW
, unmapped_value
"US"
The employee employment
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Custom Unified Fields configured in your StackOne project
{
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
}
The job title of the employee
"Software Engineer"
The pay rate for the employee
"40.00"
The pay frequency
"hourly"
The currency used for pay
"USD"
The effective date of the employment contract
"2021-01-01T01:01:01.000Z"
The type of employment (e.g., contractor, permanent)
contractor
, intern
, permanent
, apprentice
, freelance
, terminated
, temporary
, seasonal
, volunteer
, probation
, internal
, external
, expatriate
, employer_of_record
, casual
, Programme
, unmapped_value
"permanent"
The work time duration in ISO 8601 duration format
"P0Y0M0DT8H0M0S"
The employee custom fields
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The name of the custom field.
"Training Completion Status"
The value associated with the custom field.
"Completed"
The unique identifier for the value of the custom field.
"value_456"
Provider's unique identifier for the value of the custom field.
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
Current benefits of the employee
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The name of the benefit
"Health Insurance"
The provider of the benefit
"Aetna"
The description of the benefit
"Health insurance for employees"
The date and time the benefit was created
"2021-01-01T00:00:00Z"
The date and time the benefit was last updated
"2021-01-01T00:00:00Z"
The assigned employee number
"125"
The national identity number
"123456789"
The type of the national identity number
ssn
, nin
, sin
, nid
, pin
, pn
, umcn
, pic
, ric
, idnum
, cid
, nidnr
, pan
, aadhaar
, epic
, ptn
, itin
, tin
, uprc
, pcode
, ssi
, cedula
, passport
, voterid
, ntin
, bn
, fnr
, mva
, civil_id
, cnic
, nric
, fin
, uen
, registrationnumber
, nic
, personnummer
, ahv
, id
, eid
, va
, pid
, nrt
, nipt
, cbu
, cuit
, dni
, businessid
, vnr
, abn
, acn
, tfn
, jmbg
, bis
, insz
, nn
, egn
, pnf
, vat
, cnpj
, unp
, gst
, pst
, qst
, ni
, dic
, rc
, uid
, rut
, uscc
, cpf
, cpj
, cr
, stnr
, svnr
, ncf
, rnc
, nif
, ci
, ik
, kmkr
, registrikood
, tn
, ruc
, nit
, alv
, hetu
, ytunnus
, vn
, utr
, nifp
, amka
, cui
, nir
, siren
, siret
, tva
, oib
, hkid
, anum
, kennitala
, vsk
, npwp
, pps
, gstin
, idnr
, hr
, aic
, codicefiscale
, iva
, peid
, asmens
, pvm
, ctps
, vrn
, vtk
, int
, tk
, pas
, rne
, rg
, nci
, crnm
, pis
, insee
, tax
, mpf
, epfo
, esi
, pran
, uan
, idk
, bsn
, mid
, sss
, nie
, nss
, arc
, curp
, imss
, rfc
, ein
, other
, unknown
, unmapped_value
"ssn"
The country code
The ISO3166-1 Alpha2 Code of the Country
AF
, AL
, DZ
, AS
, AD
, AO
, AI
, AQ
, AG
, AR
, AM
, AW
, AU
, AT
, AZ
, BS
, BH
, BD
, BB
, BY
, BE
, BZ
, BJ
, BM
, BT
, BO
, BQ
, BA
, BW
, BV
, BR
, IO
, BN
, BG
, BF
, BI
, KH
, CM
, CA
, CV
, KY
, CF
, TD
, CL
, CN
, CX
, CC
, CO
, KM
, CG
, CD
, CK
, CR
, HR
, CU
, CW
, CY
, CZ
, CI
, DK
, DJ
, DM
, DO
, EC
, EG
, SV
, GQ
, ER
, EE
, ET
, FK
, FO
, FJ
, FI
, FR
, GF
, PF
, TF
, GA
, GM
, GE
, DE
, GH
, GI
, GR
, GL
, GD
, GP
, GU
, GT
, GG
, GN
, GW
, GY
, HT
, HM
, VA
, HN
, HK
, HU
, IS
, IN
, ID
, IR
, IQ
, IE
, IM
, IL
, IT
, JM
, JP
, JE
, JO
, KZ
, KE
, KI
, KP
, KR
, KW
, KG
, LA
, LV
, LB
, LS
, LR
, LY
, LI
, LT
, LU
, MO
, MK
, MG
, MW
, MY
, MV
, ML
, MT
, MH
, MQ
, MR
, MU
, YT
, MX
, FM
, MD
, MC
, MN
, ME
, MS
, MA
, MZ
, MM
, NA
, NR
, NP
, NL
, NC
, NZ
, NI
, NE
, NG
, NU
, NF
, MP
, NO
, OM
, PK
, PW
, PS
, PA
, PG
, PY
, PE
, PH
, PN
, PL
, PT
, PR
, QA
, RO
, RU
, RW
, RE
, BL
, SH
, KN
, LC
, MF
, PM
, VC
, WS
, SM
, ST
, SA
, SN
, RS
, SC
, SL
, SG
, SX
, SK
, SI
, SB
, SO
, ZA
, GS
, SS
, ES
, LK
, SD
, SR
, SJ
, SZ
, SE
, CH
, SY
, TW
, TJ
, TZ
, TH
, TL
, TG
, TK
, TO
, TT
, TN
, TR
, TM
, TC
, TV
, UG
, UA
, AE
, GB
, US
, UM
, UY
, UZ
, VU
, VE
, VN
, VG
, VI
, WF
, EH
, YE
, ZM
, ZW
, unmapped_value
"US"
The national identity numbers
"123456789"
The type of the national identity number
ssn
, nin
, sin
, nid
, pin
, pn
, umcn
, pic
, ric
, idnum
, cid
, nidnr
, pan
, aadhaar
, epic
, ptn
, itin
, tin
, uprc
, pcode
, ssi
, cedula
, passport
, voterid
, ntin
, bn
, fnr
, mva
, civil_id
, cnic
, nric
, fin
, uen
, registrationnumber
, nic
, personnummer
, ahv
, id
, eid
, va
, pid
, nrt
, nipt
, cbu
, cuit
, dni
, businessid
, vnr
, abn
, acn
, tfn
, jmbg
, bis
, insz
, nn
, egn
, pnf
, vat
, cnpj
, unp
, gst
, pst
, qst
, ni
, dic
, rc
, uid
, rut
, uscc
, cpf
, cpj
, cr
, stnr
, svnr
, ncf
, rnc
, nif
, ci
, ik
, kmkr
, registrikood
, tn
, ruc
, nit
, alv
, hetu
, ytunnus
, vn
, utr
, nifp
, amka
, cui
, nir
, siren
, siret
, tva
, oib
, hkid
, anum
, kennitala
, vsk
, npwp
, pps
, gstin
, idnr
, hr
, aic
, codicefiscale
, iva
, peid
, asmens
, pvm
, ctps
, vrn
, vtk
, int
, tk
, pas
, rne
, rg
, nci
, crnm
, pis
, insee
, tax
, mpf
, epfo
, esi
, pran
, uan
, idk
, bsn
, mid
, sss
, nie
, nss
, arc
, curp
, imss
, rfc
, ein
, other
, unknown
, unmapped_value
"ssn"
The country code
The ISO3166-1 Alpha2 Code of the Country
AF
, AL
, DZ
, AS
, AD
, AO
, AI
, AQ
, AG
, AR
, AM
, AW
, AU
, AT
, AZ
, BS
, BH
, BD
, BB
, BY
, BE
, BZ
, BJ
, BM
, BT
, BO
, BQ
, BA
, BW
, BV
, BR
, IO
, BN
, BG
, BF
, BI
, KH
, CM
, CA
, CV
, KY
, CF
, TD
, CL
, CN
, CX
, CC
, CO
, KM
, CG
, CD
, CK
, CR
, HR
, CU
, CW
, CY
, CZ
, CI
, DK
, DJ
, DM
, DO
, EC
, EG
, SV
, GQ
, ER
, EE
, ET
, FK
, FO
, FJ
, FI
, FR
, GF
, PF
, TF
, GA
, GM
, GE
, DE
, GH
, GI
, GR
, GL
, GD
, GP
, GU
, GT
, GG
, GN
, GW
, GY
, HT
, HM
, VA
, HN
, HK
, HU
, IS
, IN
, ID
, IR
, IQ
, IE
, IM
, IL
, IT
, JM
, JP
, JE
, JO
, KZ
, KE
, KI
, KP
, KR
, KW
, KG
, LA
, LV
, LB
, LS
, LR
, LY
, LI
, LT
, LU
, MO
, MK
, MG
, MW
, MY
, MV
, ML
, MT
, MH
, MQ
, MR
, MU
, YT
, MX
, FM
, MD
, MC
, MN
, ME
, MS
, MA
, MZ
, MM
, NA
, NR
, NP
, NL
, NC
, NZ
, NI
, NE
, NG
, NU
, NF
, MP
, NO
, OM
, PK
, PW
, PS
, PA
, PG
, PY
, PE
, PH
, PN
, PL
, PT
, PR
, QA
, RO
, RU
, RW
, RE
, BL
, SH
, KN
, LC
, MF
, PM
, VC
, WS
, SM
, ST
, SA
, SN
, RS
, SC
, SL
, SG
, SX
, SK
, SI
, SB
, SO
, ZA
, GS
, SS
, ES
, LK
, SD
, SR
, SJ
, SZ
, SE
, CH
, SY
, TW
, TJ
, TZ
, TH
, TL
, TG
, TK
, TO
, TT
, TN
, TR
, TM
, TC
, TV
, UG
, UA
, AE
, GB
, US
, UM
, UY
, UZ
, VU
, VE
, VN
, VG
, VI
, WF
, EH
, YE
, ZM
, ZW
, unmapped_value
"US"
The employee home location
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The name of the location
"Woolsthorpe Manor"
The phone number of the location
"+44 1476 860 364"
The first line of the address
"Water Lane"
The second line of the address
"Woolsthorpe by Colsterworth"
The city where the location is situated
"Grantham"
The ZIP code/Postal code of the location
"NG33 5NR"
The country code
The ISO3166-1 Alpha2 Code of the Country
AF
, AL
, DZ
, AS
, AD
, AO
, AI
, AQ
, AG
, AR
, AM
, AW
, AU
, AT
, AZ
, BS
, BH
, BD
, BB
, BY
, BE
, BZ
, BJ
, BM
, BT
, BO
, BQ
, BA
, BW
, BV
, BR
, IO
, BN
, BG
, BF
, BI
, KH
, CM
, CA
, CV
, KY
, CF
, TD
, CL
, CN
, CX
, CC
, CO
, KM
, CG
, CD
, CK
, CR
, HR
, CU
, CW
, CY
, CZ
, CI
, DK
, DJ
, DM
, DO
, EC
, EG
, SV
, GQ
, ER
, EE
, ET
, FK
, FO
, FJ
, FI
, FR
, GF
, PF
, TF
, GA
, GM
, GE
, DE
, GH
, GI
, GR
, GL
, GD
, GP
, GU
, GT
, GG
, GN
, GW
, GY
, HT
, HM
, VA
, HN
, HK
, HU
, IS
, IN
, ID
, IR
, IQ
, IE
, IM
, IL
, IT
, JM
, JP
, JE
, JO
, KZ
, KE
, KI
, KP
, KR
, KW
, KG
, LA
, LV
, LB
, LS
, LR
, LY
, LI
, LT
, LU
, MO
, MK
, MG
, MW
, MY
, MV
, ML
, MT
, MH
, MQ
, MR
, MU
, YT
, MX
, FM
, MD
, MC
, MN
, ME
, MS
, MA
, MZ
, MM
, NA
, NR
, NP
, NL
, NC
, NZ
, NI
, NE
, NG
, NU
, NF
, MP
, NO
, OM
, PK
, PW
, PS
, PA
, PG
, PY
, PE
, PH
, PN
, PL
, PT
, PR
, QA
, RO
, RU
, RW
, RE
, BL
, SH
, KN
, LC
, MF
, PM
, VC
, WS
, SM
, ST
, SA
, SN
, RS
, SC
, SL
, SG
, SX
, SK
, SI
, SB
, SO
, ZA
, GS
, SS
, ES
, LK
, SD
, SR
, SJ
, SZ
, SE
, CH
, SY
, TW
, TJ
, TZ
, TH
, TL
, TG
, TK
, TO
, TT
, TN
, TR
, TM
, TC
, TV
, UG
, UA
, AE
, GB
, US
, UM
, UY
, UZ
, VU
, VE
, VN
, VG
, VI
, WF
, EH
, YE
, ZM
, ZW
, unmapped_value
"US"
Value to pass through to the provider
{ "other_known_names": "John Doe" }
The employee work location
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The name of the location
"Woolsthorpe Manor"
The phone number of the location
"+44 1476 860 364"
The first line of the address
"Water Lane"
The second line of the address
"Woolsthorpe by Colsterworth"
The city where the location is situated
"Grantham"
The ZIP code/Postal code of the location
"NG33 5NR"
The country code
The ISO3166-1 Alpha2 Code of the Country
AF
, AL
, DZ
, AS
, AD
, AO
, AI
, AQ
, AG
, AR
, AM
, AW
, AU
, AT
, AZ
, BS
, BH
, BD
, BB
, BY
, BE
, BZ
, BJ
, BM
, BT
, BO
, BQ
, BA
, BW
, BV
, BR
, IO
, BN
, BG
, BF
, BI
, KH
, CM
, CA
, CV
, KY
, CF
, TD
, CL
, CN
, CX
, CC
, CO
, KM
, CG
, CD
, CK
, CR
, HR
, CU
, CW
, CY
, CZ
, CI
, DK
, DJ
, DM
, DO
, EC
, EG
, SV
, GQ
, ER
, EE
, ET
, FK
, FO
, FJ
, FI
, FR
, GF
, PF
, TF
, GA
, GM
, GE
, DE
, GH
, GI
, GR
, GL
, GD
, GP
, GU
, GT
, GG
, GN
, GW
, GY
, HT
, HM
, VA
, HN
, HK
, HU
, IS
, IN
, ID
, IR
, IQ
, IE
, IM
, IL
, IT
, JM
, JP
, JE
, JO
, KZ
, KE
, KI
, KP
, KR
, KW
, KG
, LA
, LV
, LB
, LS
, LR
, LY
, LI
, LT
, LU
, MO
, MK
, MG
, MW
, MY
, MV
, ML
, MT
, MH
, MQ
, MR
, MU
, YT
, MX
, FM
, MD
, MC
, MN
, ME
, MS
, MA
, MZ
, MM
, NA
, NR
, NP
, NL
, NC
, NZ
, NI
, NE
, NG
, NU
, NF
, MP
, NO
, OM
, PK
, PW
, PS
, PA
, PG
, PY
, PE
, PH
, PN
, PL
, PT
, PR
, QA
, RO
, RU
, RW
, RE
, BL
, SH
, KN
, LC
, MF
, PM
, VC
, WS
, SM
, ST
, SA
, SN
, RS
, SC
, SL
, SG
, SX
, SK
, SI
, SB
, SO
, ZA
, GS
, SS
, ES
, LK
, SD
, SR
, SJ
, SZ
, SE
, CH
, SY
, TW
, TJ
, TZ
, TH
, TL
, TG
, TK
, TO
, TT
, TN
, TR
, TM
, TC
, TV
, UG
, UA
, AE
, GB
, US
, UM
, UY
, UZ
, VU
, VE
, VN
, VG
, VI
, WF
, EH
, YE
, ZM
, ZW
, unmapped_value
"US"
Value to pass through to the provider
{ "other_known_names": "John Doe" }
Value to pass through to the provider
{ "other_known_names": "John Doe" }
Was this page helpful?
curl --request PATCH \
--url https://api.stackone.com/unified/hris/employees/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '{
"first_name": "Isaac",
"last_name": "Newton",
"name": "Isaac Newton",
"display_name": "Sir Isaac Newton",
"avatar_url": "https://example.com/avatar.png",
"personal_email": "isaac.newton@example.com",
"personal_phone_number": "+1234567890",
"work_email": "newton@example.com",
"work_phone_number": "+1234567890",
"job_id": "R-6789",
"job_title": "Physicist",
"department_id": "3093",
"team_id": "2913",
"department": "Physics",
"manager_id": "67890",
"gender": "male",
"preferred_language": "en_US",
"ethnicity": "white",
"date_of_birth": "1990-01-01T00:00.000Z",
"birthday": "2021-01-01T00:00:00Z",
"marital_status": "single",
"avatar": "https://example.com/avatar.png",
"hire_date": "2021-01-01T00:00.000Z",
"start_date": "2021-01-01T00:00.000Z",
"employment_type": "full_time",
"employment_contract_type": "full_time",
"employment_status": "active",
"termination_date": "2021-01-01T00:00:00Z",
"company_name": "Example Corp",
"company_id": "1234567890",
"citizenships": [
{
"value": "US",
"source_value": "<string>"
}
],
"employment": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"job_title": "Software Engineer",
"pay_rate": "40.00",
"pay_period": "monthly",
"pay_frequency": "hourly",
"pay_currency": "USD",
"effective_date": "2021-01-01T01:01:01.000Z",
"employment_type": "permanent",
"employment_contract_type": "full_time",
"work_time": {
"duration": "P0Y0M0DT8H0M0S",
"duration_unit": "month"
}
},
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
],
"benefits": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Health Insurance",
"benefit_type": {
"value": "retirement_savings",
"source_value": "<string>"
},
"provider": "Aetna",
"description": "Health insurance for employees",
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z"
}
],
"employee_number": "125",
"national_identity_number": {
"value": "123456789",
"type": {
"value": "ssn",
"source_value": "<string>"
},
"country": {
"value": "US",
"source_value": "<string>"
}
},
"national_identity_numbers": [
{
"value": "123456789",
"type": {
"value": "ssn",
"source_value": "<string>"
},
"country": {
"value": "US",
"source_value": "<string>"
}
}
],
"home_location": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Woolsthorpe Manor",
"phone_number": "+44 1476 860 364",
"street_1": "Water Lane",
"street_2": "Woolsthorpe by Colsterworth",
"city": "Grantham",
"zip_code": "NG33 5NR",
"country": {
"value": "US",
"source_value": "<string>"
},
"passthrough": {
"other_known_names": "John Doe"
},
"state": "GB-LIN"
},
"work_location": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Woolsthorpe Manor",
"phone_number": "+44 1476 860 364",
"street_1": "Water Lane",
"street_2": "Woolsthorpe by Colsterworth",
"city": "Grantham",
"zip_code": "NG33 5NR",
"country": {
"value": "US",
"source_value": "<string>"
},
"passthrough": {
"other_known_names": "John Doe"
},
"state": "GB-LIN"
},
"passthrough": {
"other_known_names": "John Doe"
}
}'
{
"statusCode": 200,
"message": "Record updated successfully.",
"timestamp": "2021-01-01T01:01:01.000Z"
}