List benefit products
/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.
Query Parameters
active_in: optional boolean
Filter by active status
limit: optional number
Items per page (default: 20, max: 100)
minimum1
maximum100
page: optional number
Page number (default: 1)
minimum1
Returns
id: string
Unique benefit product identifier with 'bprd_' prefix
active: boolean
Whether this product is currently available for offering
created_at: string
Timestamp when the product was created
formatdate-time
name: string
Display name of the benefit product
updated_at: string
Timestamp when the product was last updated
formatdate-time
carrier_name: optional string
Name of the insurance carrier providing this product
description: optional string
Detailed description of the benefit product
List benefit products
curl https://api.vitablehealth.com/v1/benefit-products \
-H "Authorization: Bearer $VITABLE_connect_API_API_KEY"
[
{
"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"
}
]