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

const finch = new Finch();

async function main() {
  // Automatically fetches more pages as needed.
  for await (const individualBenefit of finch.hris.benefits.individuals.retrieveManyBenefits('string')) {
    console.log(individualBenefit.individual_id);
  }
}

main();
[
  {
    "individual_id": "d02a6346-1f08-4312-a064-49ff3cafaa7a",
    "code": 200,
    "body": {
      "employee_deduction": {
        "type": "fixed",
        "amount": 100
      },
      "company_contribution": {
        "type": "fixed",
        "amount": 100
      },
      "annual_maximum": 1000,
      "catch_up": false
    }
  },
  {
    "individual_id": "e63c21ab-7cde-49d8-b6d6-ce208e84bf09",
    "code": 404,
    "body": {
      "name": "not_found_error",
      "finch_code": "individual_not_found",
      "message": "Individual not found"
    }
  }
]

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

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.

Content-Type
string
default: application/jsonrequired

Used to indicate the original media type of the resource

Path Parameters

benefit_id
string
required

Query Parameters

individual_ids
string

comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals

Response

207 - application/json
individual_id
string
code
integer
body
object