Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0755143347.0 KB
Benefits

Get Plan

Beta: This endpoint is in beta and may change. Read a single benefit plan by its Finch ID.

get/employer/plans/{plan_id}

Path parameters

plan_idstring required

The Finch ID of the benefit plan.

Query parameters

entity_idsstring[]

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

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

Headers

Finch-API-Versionstring date required

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

Response

Benefit plan data

idstring required

A stable Finch ID for the benefit plan.

namestring required

The name of the benefit plan.

type'commuter' | 'dental' | 'hsa' | 'fsa' | 'life_insurance' | 'long_term_disability' | 'medical' | 'other' | 'short_term_disability' | 'vision' | 'null' nullable required

The type of the benefit plan.

descriptionstring nullable required

A description of the benefit plan.

network_type'epo' | 'hdhp' | 'hmo' | 'other' | 'pos' | 'ppo' | 'null' nullable required

The network type of the benefit plan.

start_datestring required

The start date of the benefit plan in ISO 8601 format (YYYY-MM-DD).

end_datestring nullable required

The end date of the benefit plan in ISO 8601 format (YYYY-MM-DD).

coverage_tiersPlanCoverageTier[] nullable required

The available coverage tiers for the benefit plan. Known values: employee_only, employee_spouse, employee_children, employee_family. Provider-specific values outside this list may also be returned.

deduction_codesstring[] nullable required

The deduction codes associated with the benefit plan.