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

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

const companyBenefit = await client.hris.benefits.retrieve('benefit_id');

console.log(companyBenefit.benefit_id);
{
  "benefit_id": "6547e3aa-d887-4a77-bd41-17221e17cce3",
  "type": "401k",
  "description": "Example 401k",
  "frequency": "every_paycheck"
}
Availability: Automated providers only. Employer Match capabilities are currently in Beta. Please reach out if you are interested in gaining early access. This is a live request to the provider. Latencies may vary from seconds to minutes depending on the provider.

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.