List employee benefit eligibilities
curl --request GET \
--url https://api.vitablehealth.com/v1/companies/{company_id}/benefit-eligibilities \
--header 'X-Partner-API-Key: <api-key>'import requests
url = "https://api.vitablehealth.com/v1/companies/{company_id}/benefit-eligibilities"
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}/benefit-eligibilities', 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}/benefit-eligibilities",
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}/benefit-eligibilities"
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}/benefit-eligibilities")
.header("X-Partner-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vitablehealth.com/v1/companies/{company_id}/benefit-eligibilities")
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": [
{
"employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"employee_name": "<string>",
"benefit_eligibilities": [
{
"benefit_name": "<string>",
"benefit_code": "<string>",
"eligible": true,
"eligibility_date": "2023-12-25",
"waiting_period_days": 123
}
]
}
],
"pagination": {
"page": 123,
"limit": 123,
"total_count": 123,
"total_pages": 123
}
}Benefit Eligibility
List employee benefit eligibilities
Retrieve benefit eligibility information for employees. Helps payroll providers understand who is eligible for which benefits.
GET
/
v1
/
companies
/
{company_id}
/
benefit-eligibilities
List employee benefit eligibilities
curl --request GET \
--url https://api.vitablehealth.com/v1/companies/{company_id}/benefit-eligibilities \
--header 'X-Partner-API-Key: <api-key>'import requests
url = "https://api.vitablehealth.com/v1/companies/{company_id}/benefit-eligibilities"
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}/benefit-eligibilities', 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}/benefit-eligibilities",
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}/benefit-eligibilities"
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}/benefit-eligibilities")
.header("X-Partner-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vitablehealth.com/v1/companies/{company_id}/benefit-eligibilities")
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": [
{
"employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"employee_name": "<string>",
"benefit_eligibilities": [
{
"benefit_name": "<string>",
"benefit_code": "<string>",
"eligible": true,
"eligibility_date": "2023-12-25",
"waiting_period_days": 123
}
]
}
],
"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 by employee name
Include terminated employees
Number of results to return per page
Page number for pagination
⌘I
