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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_contribution": {
      "type": "match",
      "tiers": [
        {
          "threshold": 5000,
          "match": 5000
        }
      ]
    },
    "type": "457",
    "description": "<string>",
    "frequency": "one_time"
  }
]

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