Search company benefits
curl --request GET \
--url https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits \
--header 'X-Partner-API-Key: <api-key>'import requests
url = "https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits"
headers = {"X-Partner-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Partner-API-Key': '<api-key>'}};
fetch('https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Partner-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Partner-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits")
.header("X-Partner-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Partner-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"internal_name": "<string>",
"vitable_managed_in": true,
"plans": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"level": 123,
"tier_costs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"benefit_plan_tier_name": "<string>",
"cost": 123,
"cost_per_dependent": 123,
"dependents_required_in": true,
"spouse_required_in": true
}
],
"min_tier_cost": 123,
"max_dependent_cost": 123,
"vitable_only_in": true,
"employee_enrollment_count": 123,
"dependent_enrollment_count": 123
}
],
"eligibility_rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"readable_expression_str": "<string>",
"location_value": "<string>"
}
],
"open_enrollment_start": "2023-12-25",
"coverage_start": "2023-12-25",
"carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active_in": true,
"configured_in": true,
"allowance_based_in": true,
"health_wallet_enabled_in": true,
"open_enrollment_end": "2023-12-25",
"coverage_end": "2023-12-25"
}
],
"pagination": {
"page": 123,
"limit": 123,
"total_count": 123,
"total_pages": 123
}
}Benefits
Search company benefits
Search and filter company benefits with various criteria. Allows payroll providers to find specific benefit plans based on status, configuration, and coverage periods for comprehensive benefit management.
GET
/
v1
/
companies
/
{company_id}
/
company-benefits
Search company benefits
curl --request GET \
--url https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits \
--header 'X-Partner-API-Key: <api-key>'import requests
url = "https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits"
headers = {"X-Partner-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Partner-API-Key': '<api-key>'}};
fetch('https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Partner-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Partner-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits")
.header("X-Partner-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Partner-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"internal_name": "<string>",
"vitable_managed_in": true,
"plans": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"level": 123,
"tier_costs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"benefit_plan_tier_name": "<string>",
"cost": 123,
"cost_per_dependent": 123,
"dependents_required_in": true,
"spouse_required_in": true
}
],
"min_tier_cost": 123,
"max_dependent_cost": 123,
"vitable_only_in": true,
"employee_enrollment_count": 123,
"dependent_enrollment_count": 123
}
],
"eligibility_rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"readable_expression_str": "<string>",
"location_value": "<string>"
}
],
"open_enrollment_start": "2023-12-25",
"coverage_start": "2023-12-25",
"carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active_in": true,
"configured_in": true,
"allowance_based_in": true,
"health_wallet_enabled_in": true,
"open_enrollment_end": "2023-12-25",
"coverage_end": "2023-12-25"
}
],
"pagination": {
"page": 123,
"limit": 123,
"total_count": 123,
"total_pages": 123
}
}Authorizations
Partner API key for external integrations
Path Parameters
Unique identifier for the company
Query Parameters
Filter for active benefits only
Filter for configured benefits only
Filter for benefits with non-expired coverage and subscriptions
⌘I
