Benefit Enrollments
benefitEnrollments Based on latest (2026.09)
Look up Benefit Enrollments, with costs, dependents and providers. Read-only.
- Operations
- GET (list)GET (one)
- Record key
EnrollmentResultId- Required on create
- no create on this resource
- At a glance
- 24 fields2 finders4 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/benefitEnrollments?fields=CoverageAmount,CreatedBy,CreationDate,CurrencyCode,EnrollmentCoverageEndDate&limit=25&onlyData=true
{
"items": [
{
"CoverageAmount": 0,
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"CurrencyCode": "<string, max 30>",
"EnrollmentCoverageEndDate": "2026-01-31"
}
],
"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 24
| Attribute | Type | Use |
|---|---|---|
CoverageAmount | number | Read-only |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
CurrencyCode | text · max 30 | Read-only |
EnrollmentCoverageEndDate | date | Read-only |
EnrollmentCoverageStartDate | date | Read-only |
EnrollmentResultId | number | Read-onlySearchable |
InterimFlag | yes/no · max 30 | Read-only |
LastUpdateDate | date-time | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
NonMonetaryUnit | text · max 30 | Read-only |
ObjectVersionNumber | number | Read-only |
OptionId | number | Read-onlySearchable |
OptionName | text · max 240 | Read-onlySearchable |
OriginalCoverageStartDate | date | Read-only |
PersonId | number | Read-onlySearchable |
PersonName | text · max 240 | Read-onlySearchable |
PlanId | number | Read-onlySearchable |
PlanName | text · max 240 | Read-onlySearchable |
PlanTypeId | number | Read-onlySearchable |
PlanTypeName | text · max 240 | Read-onlySearchable |
ProgramId | number | Read-onlySearchable |
ProgramName | text · max 240 | Read-onlySearchable |
SuspendFlag | yes/no · max 30 | Read-only |
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.
findByEnrollmentResultId·EffectiveDateEnrollmentResultIdfindByPerson·DependentNameParticipantPersonIdRelationeffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 4
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/<name>. Add them to a GET with expand.
costsGET Costs · 8 fieldsActivityTypeCodeAnnualRateAmountCommunicatedRateAmountEnrollmentResultIdRateEndDateRateStartDateRateValueIdTaxTypeCodedependentsGET Dependents · 7 fieldsCoveredDependentIdDependentCoverageEndDateDependentCoverageStartDateDependentNameDependentPersonIdEnrollmentResultIdRelationshipCodeprovidersGET Providers · 8 fieldsCustomerNumberEffectiveEndDateEffectiveStartDateOrganizationIdOrganizationNamePlanIdPolicyNumberProviderOrganizationIdproviderRolesGET Provider Roles · 4 fieldsDesigneeNameDesigneeRoleProviderOrganizationIdProviderOrganizationRoleId
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/benefitEnrollmentsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByEnrollmentResultIdfor 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.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:CoverageAmount, notcoverageamount. - 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.