Search...
HomeGet StartedGuidesUse CasesAPI ReferenceSDKsIntegrationsHelp Center
Search Documentation...
⌘K
Merge.devLog inSign up
Merge API BasicsHR, Payroll, and Directory (HRIS)Recruiting (ATS)AccountingTicketingCRMMarketing AutomationFile StorageSupplemental Data
Overview
Common Models
Bank Info
GET/bank-infoGET/bank-info/{id}
Benefits
GET/benefitsGET/benefits/{id}
Companies
GET/companiesGET/companies/{id}
Dependents
GET/dependentsGET/dependents/{id}
Employee Payroll Runs
GET/employee-payroll-runsGET/employee-payroll-runs/{id}
Employees
GET/employeesPOST/employeesGET/employees/{id}POST/employees/ignore/{model_id}GET/employees/meta/post
Employer Benefits
GET/employer-benefitsGET/employer-benefits/{id}
Employments
GET/employmentsGET/employments/{id}
Groups
GET/groupsGET/groups/{id}
Locations
GET/locationsGET/locations/{id}
Pay Groups
GET/pay-groupsGET/pay-groups/{id}
Payroll Runs
GET/payroll-runsGET/payroll-runs/{id}
Time Off
GET/time-offPOST/time-offGET/time-off/{id}GET/time-off/meta/post
Time Off Balances
GET/time-off-balancesGET/time-off-balances/{id}
Timesheet Entries
Beta
GET/timesheet-entriesPOST/timesheet-entriesGET/timesheet-entries/{id}GET/timesheet-entries/meta/post
Teams
Deprecated
GET/teamsGET/teams/{id}
Linked Account
Account Details
Account Token
Delete Account
Issues
Linked Accounts
Link Token
Selective Sync
Beta
Data Management
Force Resync
Passthrough
Async Passthrough
Beta
Sync Status
Webhook Receivers
Ignore Model
Key Management
Generate Key
Regenerate Key
POST
/link-token

https://api.merge.dev/api/hris/v1/link-token

US
EU

Creates a link token to be used when linking a new end user.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
Body Parameters

end_user_email_addressString
Required
Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.

end_user_organization_nameString
Required
Your end user's organization.

end_user_origin_idString
Required
This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.

categoriesArray
Required
The integration categories to show in Merge Link.

integrationString
Optional
The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/.

link_expiry_minsInteger
Required
An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.

should_create_magic_link_urlBoolean
Optional
Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.

To relink an account and prevent creating a new one:

Pass the existing account's end_user_origin_id to the /link-token endpoint.

POST v1/link-token
JSON
{
"end_user_email_address": "string",
"end_user_organization_name": "string",
"end_user_origin_id": "string",
"categories": [
"hris"
],
"integration": "string",
"link_expiry_mins": 30,
"should_create_magic_link_url": false
}
Response
JSON
{
"link_token": "necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0",
"integration_name": "Lever",
"magic_link_url": "https://link.merge.dev/asdfjkl12345jsndfgi2i83n"
}
Previous
Linked Accounts
Next Up
Selective Sync
Get Started

Introduction
Unified API
Linked Account
Link
SDKs
API Reference

Merge API Basics
Supplemental Data

Merge ATS
Activities
Applications
Attachments
Candidates
Departments
Eeocs
Interviews
Job Interview Stages
Jobs
Offers
Offices
Reject Reasons
Scorecards
Tags
Users

Merge HRIS
Bank Info
Benefits
Companies
Dependents
Employee Payroll Runs
Employees
Employer Benefits
Employments
Groups
Locations
Pay Groups
Payroll Runs
Time Off
Time Off Balances
Timesheet Entries
Teams

Merge Accounting
Accounting Periods
Accounts
Addresses
Attachments
Balance Sheets
Cash Flow Statements
Company Info
Contacts
Credit Notes
Expenses
Income Statements
Invoices
Items
Journal Entries
Payments
Phone Numbers
Purchase Orders
Tax Rates
Tracking Categories
Transactions
Vendor Credits

Merge Ticketing
Accounts
Attachments
Collections
Comments
Contacts
Tags
Teams
Tickets
Users

Merge CRM
Accounts
Contacts
Engagement Types
Engagements
Leads
Notes
Opportunities
Stages
Tasks
Users

Merge Marketing Automation
Actions
Automations
Campaigns
Contacts
Emails
Events
Lists
Messages
Templates
Users

Merge File Storage
Drives
Files
Folders
Groups
Users

© Merge 2023
Terms of Use
Privacy Policy