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

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

async function main() {
  // Automatically fetches more pages as needed.
  for await (const companyBenefit of client.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
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.

Response

200 - application/json
OK
benefit_id
string
required

The id of the benefit.

type
enum<string> | null
required

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
required
frequency
enum<string> | null
required

The frequency of the benefit deduction/contribution.

Available options:
one_time,
every_paycheck,
monthly