For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The EmployerBenefit object
          • GET/employer-benefits
          • GET/employer-benefits/{id}

Get started

  • Overview
  • Introduction
  • Unified API
  • Linked Account
  • Merge Link
  • Use cases

Implementation

  • Sandboxes
  • SDKs
  • API access
  • Syncing data
  • Writing data
  • Data minimization
  • Supplemental data
  • Errors
  • Integration metadata

API reference

  • ATS
  • HRIS
  • Accounting
  • Ticketing
  • CRM
  • File Storage
  • Knowledge Base
  • Chat

Resources

  • Help Center
  • Merge.dev
  • Changelog
© Merge 2026Terms of usePrivacy policy
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsEmployer benefits

The EmployerBenefit object

The EmployerBenefit Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "benefit_plan_type": "MEDICAL",
7  "name": "string",
8  "description": "string",
9  "deduction_code": "string",
10  "remote_was_deleted": true,
11  "field_mappings": {
12    "organization_defined_targets": {
13      "string": {}
14    },
15    "linked_account_defined_targets": {
16      "string": {}
17    }
18  },
19  "remote_data": [
20    {
21      "path": "string",
22      "data": {}
23    }
24  ]
25}
Was this page helpful?
Previous

/employees/meta/post

Next

/employer-benefits

The Employer Benefit object is used to represent a benefit plan offered by a company.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
benefit_plan_typeenum or nullOptional
The type of benefit plan.
Allowed values:
namestring or nullOptional<=200 characters

The employer benefit's name - typically the carrier or network name.

descriptionstring or nullOptional<=2000 characters
The employer benefit's description.
deduction_codestring or nullOptional<=60 characters
The employer benefit's deduction code.
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only