v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBBenefits
Public API
List Benefit Coverages
Returns all benefit coverage levels configured in the company, such as Employee Only, Employee + Spouse, and Employee + Family. The JSON response wraps results under a "Benefit Coverages" key. Each coverage level includes an ID, short name, optional description, sort order, and an associated benefit plan ID (null for company-wide levels). Requires Benefits Administration permissions or owner/admin access.
OAuth Scopes: benefit
get/api/v1/benefitcoverages
Headers
AcceptHeaderParameter'application/xml' | 'application/json'
This endpoint can produce either JSON or XML.
Response
A collection of benefit coverage levels ordered by sort order.