Get Enrolled Individuals

JavaScript

import Finch from '@tryfinch/finch-api';

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

const response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');

console.log(response.benefit_id);

package main

import (
	"context"
	"fmt"

	"github.com/Finch-API/finch-api-go"
	"github.com/Finch-API/finch-api-go/option"
)

func main() {
	client := finchgo.NewClient(
		option.WithAccessToken("My Access Token"),
	)
	response, err := client.HRIS.Benefits.Individuals.EnrolledIDs(
		context.TODO(),
		"benefit_id",
		finchgo.HRISBenefitIndividualEnrolledIDsParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.BenefitID)
}

package com.tryfinch.api.example;

import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams;
import com.tryfinch.api.models.IndividualEnrolledIdsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        FinchClient client = FinchOkHttpClient.builder()
            .fromEnv()
            .accessToken("My Access Token")
            .build();

        IndividualEnrolledIdsResponse response = client.hris().benefits().individuals().enrolledIds("benefit_id");
    }
}

package com.tryfinch.api.example

import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams
import com.tryfinch.api.models.IndividualEnrolledIdsResponse

fun main() {
    val client: FinchClient = FinchOkHttpClient.builder()
        .fromEnv()
        .accessToken("My Access Token")
        .build()

    val response: IndividualEnrolledIdsResponse = client.hris().benefits().individuals().enrolledIds("benefit_id")
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryfinch.com/employer/benefits/{benefit_id}/enrolled",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Finch-API-Version: <finch-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "benefit_id": "6547e3aa-d887-4a77-bd41-17221e17cce3",
  "individual_ids": [
    "7fc9fb3a-2a62-47c1-9a5a-c9146483b58e"
  ]
}

{
  "code": 404,
  "name": "not_found_error",
  "finch_code": "benefit_not_found",
  "message": "Benefit not found"
}

GET

employer

benefits

{benefit_id}

enrolled

JavaScript

import Finch from '@tryfinch/finch-api';

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

const response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');

console.log(response.benefit_id);

package main

import (
	"context"
	"fmt"

	"github.com/Finch-API/finch-api-go"
	"github.com/Finch-API/finch-api-go/option"
)

func main() {
	client := finchgo.NewClient(
		option.WithAccessToken("My Access Token"),
	)
	response, err := client.HRIS.Benefits.Individuals.EnrolledIDs(
		context.TODO(),
		"benefit_id",
		finchgo.HRISBenefitIndividualEnrolledIDsParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.BenefitID)
}

package com.tryfinch.api.example;

import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams;
import com.tryfinch.api.models.IndividualEnrolledIdsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        FinchClient client = FinchOkHttpClient.builder()
            .fromEnv()
            .accessToken("My Access Token")
            .build();

        IndividualEnrolledIdsResponse response = client.hris().benefits().individuals().enrolledIds("benefit_id");
    }
}

package com.tryfinch.api.example

import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams
import com.tryfinch.api.models.IndividualEnrolledIdsResponse

fun main() {
    val client: FinchClient = FinchOkHttpClient.builder()
        .fromEnv()
        .accessToken("My Access Token")
        .build()

    val response: IndividualEnrolledIdsResponse = client.hris().benefits().individuals().enrolledIds("benefit_id")
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryfinch.com/employer/benefits/{benefit_id}/enrolled",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Finch-API-Version: <finch-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "benefit_id": "6547e3aa-d887-4a77-bd41-17221e17cce3",
  "individual_ids": [
    "7fc9fb3a-2a62-47c1-9a5a-c9146483b58e"
  ]
}

{
  "code": 404,
  "name": "not_found_error",
  "finch_code": "benefit_not_found",
  "message": "Benefit 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

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.

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))

Path Parameters

benefit_id

string

required

Query Parameters

entity_ids

string<uuid>[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

Required array length: 1 element

Example:

["550e8400-e29b-41d4-a716-446655440000"]

Response

benefit_id

string<uuid>

required

The id of the benefit.

individual_ids

string<uuid>[]

required

A stable Finch id (UUID v4) for an individual in the company.

Pattern: [0-9a-fA-F]{8}[-]?(?:[0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}

⌘I

Organization

Payroll

Deductions

Benefits

Documents

Connect

Management

Sandbox

Development Guides

Get Enrolled Individuals

Authorizations

Headers

Path Parameters

Query Parameters

Response