---
title: "Retrieve a benefit"
method: GET
path: "/hris/{connection_id}/benefit/{id}"
tags: ["hris", "benefit"]
---

# Retrieve a benefit

`GET /hris/{connection_id}/benefit/{id}`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/hris/{connection_id}/benefit/{id}`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required
- `id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Response `200`

Successful

- HrisBenefit: Company-wide benefit plans available to employees.
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `name` string: e.g. "401(k) Plan"
  - `description` string: e.g. "Company 401(k) retirement plan"
  - `company_id` string: (reference to HrisCompany)
  - `type` 'RETIREMENT' | 'HEALTH' | 'DENTAL' | 'VISION' | 'LIFE' | 'HSA' | 'FSA' | 'SHORT_TERM_DISABILITY' | 'LONG_TERM_DISABILITY' | 'WORKERS_COMP' | 'HOUSING_STIPEND' | 'EMPLOYER_TAX_CONTRIBUTION' | 'GARNISHMENT' | 'LOAN_REPAYMENT' | 'CHARITABLE_CONTRIBUTION' | 'OTHER' | 'RETIREMENT_ROTH' | 'COMMUTER' | 'DEPENDENT_CARE' | 'PENSION'
  - `tax` 'PRE_TAX' | 'POST_TAX' | 'TAXABLE' | 'NON_TAXABLE' | 'TAX': Tax describes the tax treatment of the benefit
  - `frequency` 'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY': Frequency that costs accrue for this benefit. For insurance/benefits, usually "MONTHLY". For compensation, matches pay cycle (WEEKLY, BIWEEKLY, etc).
  - `is_active` boolean
  - `employer_contribution_type` 'PERCENTAGE' | 'FIXED'
  - `employer_contribution_amount` number: percentage or money
  - `employer_contribution_max_amount` number: always money
  - `coverage_level` 'EMPLOYEE_ONLY' | 'EMPLOYEE_SPOUSE' | 'EMPLOYEE_CHILD' | 'EMPLOYEE_CHILDREN' | 'EMPLOYEE_FAMILY' | 'FAMILY' | 'OTHER'
  - `currency` string
  - `metadata` HrisMetadata[]
    - `id` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
    - `slug` string
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)
