Employers

Get one of an employer's benefit plan years

Returns one benefit plan year in full — its benefit details plus the per-benefit enrollment rate and SPD link — addressed by its benefit_plan_year_id. The caller must be authorized for the employer; an unknown or unauthorized plan year returns 404.

get/v1/employers/{employer_id}/benefit-plan-years/{benefit_plan_year_id}

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/employers/{employer_id}/benefit-plan-years/{benefit_plan_year_id}
  • Auth: HTTP bearer

Path parameters

benefit_plan_year_idstring required

Unique benefit-plan-year identifier (plyr_*).

employer_idstring required

Unique employer identifier (empr_*)

Headers

X-Vitable-Organizationstring

Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.

Response

Changes

No recorded changes to this operation across all 1 revision of this API.