HomeGuidesAPI ReferenceChangelogDiscussions
API Reference
These docs are for v2024-10-01. Click to read the latest docs for v2025-01-01.

Reads all Family situations

Get all family situations.

Log in to see full request history
Query Params
employee_ids[]
array of integers

employee ids.

employee_ids[]
Response

Response body
array of objects
object
integer
required

ID of the family situation.

integer
required

Employee id of the family situation.

string

Civil status of the employee.

single cohabitating divorced married unknown civil_partnership separated widow not_applicable

integer

Number of dependants of the employee.

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json