List Hsa Contribution Summaries
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
Restricts results to the given employers. Repeat the parameter to select several. Every value is validated against the calling partner's authorized employer set, and a value outside it fails the request with 403.
Show child attributes
Restricts results to a single participant. The identifier is assigned by the employer and is not unique across employers, so employer_id must be supplied alongside it; otherwise the request fails with 400.
Restricts results to a single custodian-issued HSA account identifier.
Restricts results to participants with this employment status as of the snapshot, for example Active.
Restricts results to accounts with this status as of the snapshot, for example Open.
Restricts results to participants flagged as at risk of exceeding their IRS contribution limit (true) or not flagged (false).
Restricts results to participants with no contributions recorded for the current tax year (true) or with at least one contribution (false).
Zero-based page index.
Maximum number of rows to return per page (1-100).
Response
Contribution summaries retrieved successfully
Response Attributes
The contribution summaries for this page.
Show child attributes
Show child attributes
Bad Request – Validation failed. The errors map keys mirror the snake_case JSON property names used in the request payload.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized – Missing or invalid credentials.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Forbidden – Insufficient permissions.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Not Found – Employee record does not exist.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal Server Error.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: