Wex Health and Benefits APIs

Sections

Theme switcher

Search Employees

Header Parameters

X-Request-Idstring

Optional correlation ID for distributed tracing.

Authorizationstring

Body Parameters

pageinteger

Zero-based page index.

Default value
0
page_sizeinteger

Number of items per page.

Minimum
1
Maximum
100
Default value
20
employer_idstring

Filter by employer identifier (exact match).

Max length
100
partner_idstring

Filter by partner identifier (exact match).

Max length
100
employee_numberstring

Filter by employee number (exact match).

Max length
100
first_namestring

Filter by first name (case-insensitive contains).

Max length
255
last_namestring

Filter by last name (case-insensitive contains).

Max length
255
emailstring

Filter by email address (case-insensitive contains).

Max length
255

Response

200
Object

OK – Paginated list of employee records

Response Attributes

itemsarray Required

Employee records for the current page.

Max items
100

Show child attributes

pageinteger Required

Zero-based page index.

page_sizeinteger Required

Number of items per page.

has_nextboolean Required

True if more pages exist.

paginationobject | null Required

Show child attributes

400
Object

Bad Request – Validation failed. The errors map keys mirror the snake_case JSON property names used in the request payload.

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorsobject

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

Show child attributes

validation_errorsobject

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

401
Object

Unauthorized – Missing or invalid credentials.

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

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.

403
Object

Forbidden – Insufficient permissions.

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

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.

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

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.

default
Object

Internal Server Error.

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

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?

POST

/

Select
1

Response

Was this section helpful?