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

const finch = new Finch();

async function main() {
  // Automatically fetches more pages as needed.
  for await (const companyBenefit of finch.hris.benefits.list()) {
    console.log(companyBenefit.benefit_id);
  }
}

main();
[
  {
    "benefit_id": "e8b90071-0c11-471c-86e8-e303ef2f6782",
    "type": "401k",
    "description": "Example 401k",
    "frequency": "every_paycheck"
  }
]

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 items.

Authorizations

Authorization
string
headerrequired

Please use your Access Token

Headers

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

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

Response

200 - application/json
benefit_id
string
type
enum<string> | null

Type of benefit.

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