Sign in
hris/employerbenefits

List Employer Benefits

get/hris/employerbenefits

Query parameters

remote_databoolean

Set to true to include data from the original software.

limitnumber

Set to get the number of records.

cursorstring

Set to get the number of records after this cursor.

Headers

x-connection-tokenstring required

The connection token

Response

prev_cursorstring nullable required
next_cursorstring nullable required

Example response

{
  "data": [
    {
      "benefit_plan_type": "Health Insurance",
      "name": "Company Health Plan",
      "description": "Comprehensive health insurance coverage for employees",
      "deduction_code": "HEALTH-001",
      "field_mappings": {
        "custom_field_1": "value1",
        "custom_field_2": "value2"
      },
      "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "benefit_1234",
      "remote_data": {
        "raw_data": {
          "additional_field": "some value"
        }
      },
      "remote_created_at": "2024-10-01T12:00:00Z",
      "created_at": "2024-10-01T12:00:00Z",
      "modified_at": "2024-10-01T12:00:00Z"
    }
  ]
}

Changes