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

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

// Automatically fetches more pages as needed.
for await (const companyBenefit of client.hris.benefits.list()) {
  console.log(companyBenefit.benefit_id);
}
[
  {
    "benefit_id": "e8b90071-0c11-471c-86e8-e303ef2f6782",
    "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 and number of items.

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.

Response

200 - application/json

OK

Array of company benefits.

​
benefit_id
string<uuid>
required

The id of the benefit.

​
type
enum<string> | null
required

Type of benefit.

Available options:
457,
401k,
401k_roth,
401k_loan,
403b,
403b_roth,
457_roth,
commuter,
custom_post_tax,
custom_pre_tax,
fsa_dependent_care,
fsa_medical,
hsa_post,
hsa_pre,
s125_dental,
s125_medical,
s125_vision,
simple,
simple_ira
​
description
string | null
required
​
frequency
enum<string> | null
required

The frequency of the benefit deduction/contribution.

Available options:
every_paycheck,
monthly,
one_time
​
company_contribution
object | null

The company match for this benefit.