GET
/
employer
/
benefits
/
{benefit_id}
/
enrolled
JavaScript
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

const response = await client.hris.benefits.individuals.enrolledIds('benefit_id');

console.log(response.benefit_id);
{
  "benefit_id": "6547e3aa-d887-4a77-bd41-17221e17cce3",
  "individual_ids": [
    "7fc9fb3a-2a62-47c1-9a5a-c9146483b58e"
  ]
}

Availability: Automated providers only

This is a live request to the provider. Latencies may vary from seconds to minutes depending on the provider and number of benefits.

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

​
Finch-API-Version
string
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Path Parameters

​
benefit_id
string
required

Response

200
application/json

OK

The response is of type object.