List available plan years

GET

/v1/health/years

• Production

Returns the current default plan year and all years with loaded data.

Authorizations

• bearerAuth

Responses

200

Available plan years with HAL _links

Available plan years with HAL _links

object

_links

object

self

A HAL link object (draft-kelly-json-hal-11 §5)

object

href

required

Target URI or URI Template

string format: uri-reference

templated

True when href is an RFC 6570 URI Template

boolean

type

Media type hint for the target resource

string

title

Human-readable link title

string

current_year

Default plan year when year parameter is omitted

integer

available_years

All years with loaded plan data

Array<integer>

Example

{
  "_links": {
    "self": {
      "href": "https://api.opelyx.com/v1/health/years",
      "type": "application/json"
    }
  },
  "current_year": 2026,
  "available_years": [
    2026
  ]
}

Headers

X-Request-Id

string format: uuid

Unique request identifier for tracing

Link

string

RFC 8288 Web Linking (pagination and resource discovery)

ETag

string

Weak ETag for conditional request support (If-None-Match)

401

Missing or invalid API key

RFC 9457 Problem Details for HTTP APIs (application/problem+json)

object

type

required

URI identifying the problem type. about:blank for standard HTTP status semantics.

string format: uri

title

required

Short human-readable summary of the problem type

string

status

required

HTTP status code

integer

detail

required

Human-readable explanation specific to this occurrence

string

instance

URI reference identifying the specific occurrence (request path)

string format: uri-reference

errors

Validation errors (extension member, present on 400 responses)

Array<object>

object

field

Dot-delimited path to the invalid field

string

message

Validation error message

string

required_tier

Minimum subscription tier required (extension member, present on 402 responses)

string

Allowed values: pro enterprise

upgrade

URL to upgrade subscription (extension member, present on 402/429 responses)

string format: uri

Example

{
  "type": "https://api.opelyx.com/problems/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "Plan 99999XX0000000-00 not found.",
  "instance": "/v1/health/plans/99999XX0000000-00"
}

Headers

WWW-Authenticate

string

Bearer authentication challenge

429

Rate limit exceeded

RFC 9457 Problem Details for HTTP APIs (application/problem+json)

object

type

required

URI identifying the problem type. about:blank for standard HTTP status semantics.

string format: uri

title

required

Short human-readable summary of the problem type

string

status

required

HTTP status code

integer

detail

required

Human-readable explanation specific to this occurrence

string

instance

URI reference identifying the specific occurrence (request path)

string format: uri-reference

errors

Validation errors (extension member, present on 400 responses)

Array<object>

object

field

Dot-delimited path to the invalid field

string

message

Validation error message

string

required_tier

Minimum subscription tier required (extension member, present on 402 responses)

string

Allowed values: pro enterprise

upgrade

URL to upgrade subscription (extension member, present on 402/429 responses)

string format: uri

Example

{
  "type": "https://api.opelyx.com/problems/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "Plan 99999XX0000000-00 not found.",
  "instance": "/v1/health/plans/99999XX0000000-00"
}

Headers

Retry-After

integer

Seconds until the rate limit resets

RateLimit-Limit

integer

Maximum requests per day for this tier

RateLimit-Remaining

integer

Remaining requests today

RateLimit-Reset

integer

Unix timestamp when the limit resets (midnight UTC)