Skip to content
Vitable Docs Vitable Docs Vitable Docs
Get started
API Reference
Benefit Products

List benefit products

benefit_products.list(BenefitProductListParams**kwargs) -> BenefitProductListResponse
get/v1/benefit-products

Retrieves a paginated list of all benefit products that the authenticated organization has access to and can offer to their employers. Use query parameters to filter by category, product code, or active status.

ParametersExpand Collapse
active_in: Optional[bool]

Filter by active status

category: Optional[Category]

Filter by product category

Accepts one of the following:
"Medical"
"Dental"
"Vision"
"Hospital"
limit: Optional[int]

Items per page (default: 20, max: 100)

minimum1
maximum100
page: Optional[int]

Page number (default: 1)

minimum1
product_code: Optional[ProductCode]

Filter by product code

Accepts one of the following:
"EBA"
"VPC"
"VPC_CORE"
"MEC"
"MEC2"
"MEC_PLUS"
"MVP"
"MVP2"
"MVPSL"
"MVPSL2"
"VD"
"VV"
"ICHRA"
"ICHRA_PREMIUM_PLUS"
"ICHRA_REIMBURSEMENT_ONLY"
ReturnsExpand Collapse
BenefitProductListResponse = List[BenefitProductListResponseItem]
id: str

Unique benefit product identifier with 'bprd_' prefix

active: bool

Whether this product is currently available for offering

category: Category
  • Medical - Medical
  • Dental - Dental
  • Vision - Vision
  • Hospital - Hospital
Accepts one of the following:
"Medical"
"Dental"
"Vision"
"Hospital"
created_at: datetime

Timestamp when the product was created

formatdate-time
name: str

Display name of the benefit product

product_code: ProductCode
  • EBA - Eba Mec
  • VPC - Vpc Enhanced
  • VPC_CORE - Vpc Core
  • MEC - Vpc Mec
  • MEC2 - Mec2
  • MEC_PLUS - Mec Plus
  • MVP - Mvp
  • MVP2 - Mvp2
  • MVPSL - Mvpsl
  • MVPSL2 - Mvpsl2
  • VD - Dental
  • VV - Vision
  • ICHRA - Ichra
  • ICHRA_PREMIUM_PLUS - Ichra Premium Plus
  • ICHRA_REIMBURSEMENT_ONLY - Ichra Reimbursement Only
Accepts one of the following:
"EBA"
"VPC"
"VPC_CORE"
"MEC"
"MEC2"
"MEC_PLUS"
"MVP"
"MVP2"
"MVPSL"
"MVPSL2"
"VD"
"VV"
"ICHRA"
"ICHRA_PREMIUM_PLUS"
"ICHRA_REIMBURSEMENT_ONLY"
updated_at: datetime

Timestamp when the product was last updated

formatdate-time
carrier_name: Optional[str]

Name of the insurance carrier providing this product

description: Optional[str]

Detailed description of the benefit product

List benefit products
from vitable_connect_api import VitableConnectAPI

client = VitableConnectAPI(
    api_key="My API Key",
)
benefit_products = client.benefit_products.list()
print(benefit_products)
[
  {
    "id": "id",
    "active": true,
    "category": "Medical",
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "product_code": "EBA",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "carrier_name": "carrier_name",
    "description": "description"
  }
]
Returns Examples
[
  {
    "id": "id",
    "active": true,
    "category": "Medical",
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "product_code": "EBA",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "carrier_name": "carrier_name",
    "description": "description"
  }
]