Benefit Groups REST Endpoints

Sort by

Task Path Method

Benefit Groups

The benefitGroups resource is used to view, create, modify, or delete a benefits group. It's a setup-side entity in the Benefits product, used to group persons or employees for the participation, election, or maintenance processes. You also use this resource to include or exclude people in benefit plans, options, or rate values through eligibility profile criteria.

Create a benefit group

Method: post

Path: /hcmRestApi/resources/11.13.18.05/benefitGroups

Delete a benefit group

Method: delete

Path: /hcmRestApi/resources/11.13.18.05/benefitGroups/{BenefitGroupName}

Get a benefit group

Method: get

Path: /hcmRestApi/resources/11.13.18.05/benefitGroups/{BenefitGroupName}

Get all benefit groups

Method: get

Path: /hcmRestApi/resources/11.13.18.05/benefitGroups

Update a benefit group

Method: patch

Path: /hcmRestApi/resources/11.13.18.05/benefitGroups/{BenefitGroupName}