Skip to main content
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<date>
default:2020-09-17
required

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

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))

Path Parameters

​
benefit_id
string
required

Query Parameters

​
entity_ids
string<uuid>[]

The entity IDs to specify which entities' data to access.

Required array length: 1 element
Example:
["550e8400-e29b-41d4-a716-446655440000"]

Response

OK

​
benefit_id
string<uuid>
required

The id of the benefit.

​
individual_ids
string<uuid>[]
required

A stable Finch id (UUID v4) for an individual in the company.

Pattern: [0-9a-fA-F]{8}[-]?(?:[0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}