Sign in

v1

latestOpenAPI 3.0.02026-07-13483586.3 KB
Benefits
Pagination
Search

List all benefits subscriptions

get/benefits

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

pagenumber

Page number to retrieve

Example:1

Specify the page number to retrieve

pageSizenumber

Number of elements per page

Example:1

Specify the number of items per page

Response

Successful operation

idstring required
category'HEALTHCARE' | 'SPORT_WELLNESS' | 'LUNCH_FOOD' | 'CULTURE_RECREATION' required
countrystring required
citystring required
monthlyFeenumber required

Monetary value in EUR

subscribedAtDatestring date required
cancelledAtDatestring date

Example response

[
  {
    "id": "60965cfccf2844a6",
    "beneficiary": {
      "name": "Eva Koster",
      "email": "evko@softix.nl"
    },
    "city": "Utrecht",
    "country": "Netherlands",
    "service": {
      "name": "MultiSport Active Plus",
      "provider": "Benefit Systems"
    },
    "monthlyFee": 250,
    "subscribedAtDate": "2016-01-01",
    "cancelledAtDate": "2016-05-31"
  }
]