Employees
emps Based on latest (2026.09)
Create, change and look up Employees, with assignments, direct reports and person extra information.
The record key empsUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
Oracle documents an Effective-Of header and an effectiveDate parameter for this resource, used for date-effective reads and changes.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)
- Record key
empsUniqID- Required on create
CitizenshipLegislationCodeCitizenshipStatusCountryEffectiveStartDateHireDateHomeFaxNumberHomePhoneNumberLastNameLegalEntityIdNationalIdNationalIdCountryNationalIdTypeWorkEmailWorkFaxNumberWorkMobilePhoneNumberWorkPhoneNumber- At a glance
- 80 fields2 finders11 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/emps?fields=AddressLine1,AddressLine2,AddressLine3,CitizenshipId,CitizenshipLegislationCode&limit=25&onlyData=true
{
"items": [
{
"AddressLine1": "<string, max 240>",
"AddressLine2": "<string, max 240>",
"AddressLine3": "<string, max 240>",
"CitizenshipId": 0,
"CitizenshipLegislationCode": "<string, max 30>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 80
| Attribute | Type | Use |
|---|---|---|
AddressLine1 | text · max 240 | Optional on createUpdatableSearchable |
AddressLine2 | text · max 240 | Optional on createUpdatableSearchable |
AddressLine3 | text · max 240 | Optional on createUpdatableSearchable |
CitizenshipId | number | Optional on createSearchable |
CitizenshipLegislationCode | text · max 30 | Required on createSearchable |
CitizenshipStatus | text · max 30 | Required on createUpdatableSearchable |
CitizenshipToDate | date | Optional on createUpdatableSearchable |
City | text · max 60 | Optional on createUpdatableSearchable |
CorrespondenceLanguage | text · max 30 | Optional on createUpdatableSearchable |
Country | text · max 60 | Required on createSearchable |
CreationDate | date-time | Read-onlySearchable |
DateOfBirth | date | Optional on createUpdatableSearchable |
DisplayName | text · max 240 | Optional on createUpdatableSearchable |
DriversLicenseExpirationDate | date | Optional on createUpdatableSearchable |
DriversLicenseId | number | Optional on createSearchable |
DriversLicenseIssuingCountry | text · max 30 | Optional on createUpdatableSearchable |
EffectiveStartDate | date | Required on createUpdatableSearchable |
Ethnicity | text · max 30 | Optional on createUpdatableSearchable |
FirstName | text · max 150 | Optional on createUpdatableSearchable |
Gender | text · max 30 | Optional on createUpdatableSearchable |
HireDate | date | Required on createUpdatableSearchable |
HomeFaxAreaCode | text · max 30 | Optional on createUpdatableSearchable |
HomeFaxCountryCode | text · max 30 | Optional on createUpdatableSearchable |
HomeFaxExtension | text · max 60 | Optional on createUpdatableSearchable |
HomeFaxLegislationCode | text · max 4 | Optional on createUpdatableSearchable |
HomeFaxNumber | text · max 60 | Required on createUpdatableSearchable |
HomePhoneAreaCode | text · max 30 | Optional on createUpdatableSearchable |
HomePhoneCountryCode | text · max 30 | Optional on createUpdatableSearchable |
HomePhoneExtension | text · max 60 | Optional on createUpdatableSearchable |
HomePhoneLegislationCode | text · max 4 | Optional on createUpdatableSearchable |
HomePhoneNumber | text · max 60 | Required on createUpdatableSearchable |
Honors | text · max 80 | Optional on createUpdatableSearchable |
LastName | text · max 150 | Required on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LegalEntityId | number | Required on createUpdatable |
LicenseNumber | text · max 150 | Optional on createUpdatableSearchable |
MaritalStatus | text · max 30 | Optional on createUpdatableSearchable |
MiddleName | text · max 80 | Optional on createUpdatableSearchable |
MilitaryVetStatus | text · max 30 · default N | Optional on createUpdatableSearchable |
NameSuffix | text · max 80 | Optional on createUpdatableSearchable |
NationalId | text · max 30 | Required on createUpdatableSearchable |
NationalIdCountry | text · max 30 | Required on createSearchable |
NationalIdExpirationDate | date | Optional on createUpdatableSearchable |
NationalIdPlaceOfIssue | text · max 30 | Optional on createUpdatableSearchable |
NationalIdType | text · max 30 | Required on createUpdatableSearchable |
PassportExpirationDate | date | Optional on createUpdatableSearchable |
PassportId | number | Optional on createSearchable |
PassportIssueDate | date | Optional on createUpdatableSearchable |
PassportIssuingCountry | text · max 30 | Optional on createUpdatableSearchable |
PassportNumber | text · max 30 | Optional on createUpdatableSearchable |
PersonId | number | Optional on createSearchable |
PersonNumber | text · max 30 | Optional on createUpdatableSearchable |
PostalCode | text · max 30 | Optional on createUpdatableSearchable |
PreferredName | text · max 80 | Optional on createUpdatableSearchable |
PreviousLastName | text · max 150 | Optional on createUpdatableSearchable |
ProjectedTerminationDate | date | Optional on createUpdatableSearchable |
Region | text · max 120 | Optional on createUpdatableSearchable |
Region2 | text · max 120 | Optional on createUpdatableSearchable |
Religion | text · max 30 | Optional on createUpdatableSearchable |
ReligionId | number | Optional on createSearchable |
Salutation | text · max 30 | Optional on createUpdatableSearchable |
TerminationDate | date | Read-onlySearchable |
UserName | text · max 100 | Optional on createUpdatableSearchable |
WorkEmail | text · max 240 | Required on createUpdatableSearchable |
WorkFaxAreaCode | text · max 30 | Optional on createUpdatableSearchable |
WorkFaxCountryCode | text · max 30 | Optional on createUpdatableSearchable |
WorkFaxExtension | text · max 60 | Optional on createUpdatableSearchable |
WorkFaxLegislationCode | text · max 4 | Optional on createUpdatableSearchable |
WorkFaxNumber | text · max 60 | Required on createUpdatableSearchable |
WorkMobilePhoneAreaCode | text · max 30 | Optional on createUpdatableSearchable |
WorkMobilePhoneCountryCode | text · max 30 | Optional on createUpdatableSearchable |
WorkMobilePhoneExtension | text · max 60 | Optional on createUpdatableSearchable |
WorkMobilePhoneLegislationCode | text · max 4 | Optional on createUpdatableSearchable |
WorkMobilePhoneNumber | text · max 60 | Required on createUpdatableSearchable |
WorkPhoneAreaCode | text · max 30 | Optional on createUpdatableSearchable |
WorkPhoneCountryCode | text · max 30 | Optional on createUpdatableSearchable |
WorkPhoneExtension | text · max 60 | Optional on createUpdatableSearchable |
WorkPhoneLegislationCode | text · max 4 | Optional on createUpdatableSearchable |
WorkPhoneNumber | text · max 60 | Required on createUpdatableSearchable |
WorkerType | text · max 30 | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByAssignmentAttr·BusinessUnitNameDepartmentNameGradeNameJobNameLocationNameManagerFullNamefindByPersonId·PersonIdSysEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 11
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/<name>. Add them to a GET with expand.
assignmentsGET · POST · PATCH Assignments · 52 fields · 2 findersActionCodeActionReasonCodeActualTerminationDateAssignmentCategoryAssignmentIdAssignmentNameAssignmentNumberAssignmentProjectedEndDateAssignmentStatusAssignmentStatusTypeIdBusinessUnitIdCreationDateDefaultExpenseAccountDepartmentIdEffectiveEndDateEffectiveStartDateEndTimeFrequencyFullPartTimeGradeIdGradeLadderIdJobIdLastUpdateDateLegalEntityIdLocationIdManagerAssignmentIdManagerIdManagerTypeOriginalHireDatePeopleGroupPeriodOfServiceIdPersonTypeIdPositionIdPrimaryAssignmentFlagPrimaryWorkRelationFlagPrimaryWorkTermsFlagProbationPeriodEndDateProbationPeriodLengthProbationPeriodUnitOfMeasureProjectedStartDateProposedPersonTypeIdRegularTemporarySalaryAmountSalaryBasisIdSalaryCodeStartTimeTermsEffectiveStartDateWorkTaxAddressIdWorkerCategoryWorkingAsManagerWorkingAtHomeWorkingHoursassignmentDFFGET · POST · PATCH Assignment Legislative Descriptive Flexfields · 8 fieldsAssignmentIdAssignmentTypeEffectiveEndDateEffectiveLatestChangeEffectiveSequenceEffectiveStartDate__FLEX_Context__FLEX_Context_DisplayValueassignmentExtraInformationGET · POST · PATCH Assignment Extensible Flexfields · 1 findersFields depend on your pod's flexfield setup (check
/describe).emprepsGET Employee Representatives · 6 fieldsAsgResponsibilityIdAssignmentIdPersonIdResponsibilityNameResponsibilityTypeCodeResponsibilityTypeNamepeopleGroupKeyFlexfieldGET People Group Key Flexfields · 5 fields · 1 findersEnabledFlagEndDateActiveStartDateActive_ID_FLEX_NUM_PEOPLE_GROUP_IDdirectReportsGET Direct Reports · 4 fieldsEffectiveStartDateFullNameManagerIdPersonIdpersonDFFGET · POST · PATCH Person Descriptive Flexfields · 3 fieldsPersonId__FLEX_Context__FLEX_Context_DisplayValuepersonExtraInformationGET · POST · PATCH Person Extra Information Extensible Flexfields · 1 findersFields depend on your pod's flexfield setup (check
/describe).photoGET · POST · PATCH · DELETE Photos · 6 fieldsImageImageIdImageNameObjectVersionNumberPersonIdPrimaryFlagrolesGET · POST · PATCH · DELETE Roles · 7 fields · 1 findersCreationDateEndDateLastUpdateDateRoleCommonNameRoleGUIDRoleNameStartDatevisasGET Visas · 7 fieldsCreationDateLastUpdateDateVisaPermitCountryVisaPermitExpirationVisaPermitIdVisaPermitNumberVisaPermitType
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/empsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByAssignmentAttrfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:AddressLine1, notaddressline1. - 4 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.