Wex Health and Benefits APIs

Sections

Theme switcher

Get Eligible Expenses By Plan Ids

Header Parameters

X-Request-Idstring

Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.

Query Parameters

person_idstring Required

The GUID of the person (participant)

plan_idsarray Required

List of plan GUIDs (maps to PlanSystemId in BenefitsOffering)

Show child attributes

active_onlyboolean

If true, return only active eligible expenses

Response

200
Object

Successfully retrieved expense categories and types

Response Attributes

categoriesarray

List of eligible expense categories with their nested types.

Show child attributes

400
Object

Invalid request. Check query parameters.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

401
Object

Unauthorized. Authentication failed.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

404
Object

Not Found. No matching plans found.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

500
Object

Internal server error.

default
Object

Unexpected error

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

Was this section helpful?

Base URL

Production:

Sandbox:

Language Box

GET

/

Select
1

Response

Was this section helpful?