v1
latestOpenAPI 3.0.02026-07-13483586.3 KBBenefits
Search
Get total number of benefits
get/benefits/count
Query parameters
serviceNamestring
Filter benefits by service name
Example:MultiSport
Filter benefits by service name
categoriesstring
Comma-separated list of category codes to filter by. The search result will return benefits that match any of the provided categories (ANY).
Example:HEALTHCARE,SPORT_WELLNESS
Filter benefits by categories
employeeIdstring
The employee whom this benefit is subscribed to
Example:91720
Filter benefits by employee ID
feeFromstring
Minimum monthly fee amount
Example:100
Minimum monthly fee amount
feeTostring
Maximum monthly fee amount
Example:500.50
Maximum monthly fee amount
status'ALL' | 'ACTIVE' | 'CANCELLED'
Status filter for benefit subscriptions
Example:ACTIVE
Filter benefits by status
Response
Successful operation
integer required
Example response
42