Benefits
Search

Get total number of benefits

Changed on
get/benefits/count

Request

Query parameters

serviceNamestring

Filter benefits by service name

Example:MultiSport
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
feeTostring

Maximum monthly fee amount

Example:500.50
status'ALL' | 'ACTIVE' | 'CANCELLED'

Status filter for benefit subscriptions

Example:ACTIVE

Filter benefits by status

Response

Successful operation

integer required

Example response

42

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      api tag Search added