API Reference

Get dependants of user

get
https://connect-sandbox.onehub.global/users//dependants

Get dependants of user at Benifex platform. This endpoint allows user dependants to be fetched using their OneHub user ID. The response contains information about the user's dependants.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The identifier of user id in OneHub.

Query Params
boolean

Filter dependants by their status. If true, only current dependants will be returned.

boolean

Filter dependants by their employment status. If true, only dependants in full-time employment will be returned.

string
enum

Filter dependants by their relationship to the user. If provided, only dependants with the specified relationship will be returned.

boolean

Filter dependants by their disability status. If true, only permanently disabled dependants will be returned.

string
enum

Filter dependants by their marital status. If provided, only dependants with the specified marital status will be returned.

Allowed:
string
enum

Filter dependants by their status. If provided, only dependants with the specified status will be returned.

Allowed:
Headers
string

An id that uniquely identifies the request. If added, this will aid any request debugging and can be used for idempotency checks

Responses

Updated 10 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago