Retrieve Benefit Plan Year
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.
Authentication
AuthorizationBearer
API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.
Path parameters
benefit_plan_year_id
Unique benefit-plan-year identifier (plyr_*).
employer_id
Unique employer identifier (empr_*)
Headers
X-Vitable-Organization
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 headers
X-RateLimit-Limit
Maximum number of requests allowed within the rate limit window
X-RateLimit-Remaining
Number of requests remaining in the current rate limit window
X-RateLimit-Reset
Unix timestamp (seconds) when the rate limit window resets
Response
data
The benefit plan year, including its plans and contribution rules.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error