API Reference

Benefit Products

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List benefit products

benefit_products.list(**kwargs) -> BenefitProductListResponse { id, active, category, 6 more }

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: bool

Filter by active status

category: Category

Filter by product category

Accepts one of the following:

:Medical

:Dental

:Vision

:Hospital

limit: Integer

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

minimum1

maximum100

page: Integer

Page number (default: 1)

minimum1

product_code: 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

Array[{ id, active, category, 6 more}]

id: String

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: Time

Timestamp when the product was created

formatdate-time

name: String

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: Time

Timestamp when the product was last updated

formatdate-time

carrier_name: String

Name of the insurance carrier providing this product

description: String

Detailed description of the benefit product

List benefit products

Ruby

HTTP

TypeScript

Python

Ruby

require "vitable_connect_api"

vitable_connect_api = VitableConnectAPI::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

benefit_products = vitable_connect_api.benefit_products.list

puts(benefit_products)

200 example

[
  {
    "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

200 example

[
  {
    "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"
  }
]