get https://api.bamboohr.com/api/gateway.php//v1/benefitcoverages
Get benefit coverages
Sample Response
{
"Benefit Coverages": [
{
"id": "1",
"shortName": "Employee",
"description": null,
"sortOrder": "10"
},
{
"id": "2",
"shortName": "Employee + Spouse",
"description": null,
"sortOrder": "20"
},
{
"id": "3",
"shortName": "Employee + Family",
"description": null,
"sortOrder": "30"
},
{
"id": "4",
"shortName": "Employee + Child",
"description": null,
"sortOrder": "40"
},
{
"id": "5",
"shortName": "Employee + Children",
"description": null,
"sortOrder": "50"
},
{
"id": "6",
"shortName": "Two Party",
"description": null,
"sortOrder": "60"
},
{
"id": "7",
"shortName": "Family Only",
"description": "Employee not included",
"sortOrder": "70"
}
]
}
<BenefitCoverages>
<BenefitCoverage id="1" shortName="Employee" description="" sortOrder="10"/>
<BenefitCoverage id="2" shortName="Employee + Spouse" description="" sortOrder="20"/>
<BenefitCoverage id="3" shortName="Employee + Family" description="" sortOrder="30"/>
<BenefitCoverage id="4" shortName="Employee + Child" description="" sortOrder="40"/>
<BenefitCoverage id="5" shortName="Employee + Children" description="" sortOrder="50"/>
<BenefitCoverage id="6" shortName="Two Party" description="" sortOrder="60"/>
<BenefitCoverage id="7" shortName="Family Only" description="Employee not included" sortOrder="70"/>
</BenefitCoverages>
Notes
Benefit Coverage ID is optional. Not supplying the benefit coverage ID will return the collection of all available benefit coverages.