HomeGet StartedGuidesAPI ReferenceSDKsIntegrations
Merge.devLog inSign up
Merge API BasicsHR, Payroll, and Directory (HRIS)Recruiting (ATS)AccountingTicketingCRMSupplemental Data
Overview
Common Models
Accounts
The Account objectGET/accountsPOST/accountsGET/accounts/{id}GET/accounts/meta/post
Contacts
The Contact objectGET/contactsPOST/contactsGET/contacts/{id}GET/contacts/meta/post
Engagement Types
The EngagementType objectGET/engagement-typesGET/engagement-types/{id}
Engagements
The Engagement objectGET/engagementsPOST/engagementsGET/engagements/{id}GET/engagements/meta/post
Leads
The Lead objectGET/leadsPOST/leadsGET/leads/{id}GET/leads/meta/post
Notes
The Note objectGET/notesPOST/notesGET/notes/{id}GET/notes/meta/post
Opportunities
The Opportunity objectGET/opportunitiesPOST/opportunitiesGET/opportunities/{id}GET/opportunities/meta/post
Stages
The Stage objectGET/stagesGET/stages/{id}
Tasks
The Task objectGET/tasksGET/tasks/{id}
Users
The User objectGET/usersGET/users/{id}
Linked Account
Account Details
Account Token
Delete Account
Issues
Linked Accounts
Link Token
Data Management
Force Resync
Passthrough
Sync Status
Webhook Receivers
Key Management
Generate Key
Regenerate Key
POST

/link-token

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
Unique ID for your end user.

end_user_organization_nameString
Required
Your end user's organization.

end_user_origin_idString
Required
Your end user's email address.

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/product/integrations,-fast.-say-hello-to-magic-link/.

Response
JSON
{
"link_token": "necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0",
"integration_name": "Lever",
"magic_link_url": "https://link.merge.dev/asdfjkl12345jsndfgi2i83n"
}

Previous

Linked Accounts

Next Up

Force Resync

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
Deductions
Employee Payroll Runs
Employees
Employments
Groups
Locations
Pay Groups
Payroll Runs
Teams
Time Off
Time Off Balances


Merge Accounting
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
Comments
Contacts
Projects
Tags
Teams
Tickets
Users


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

© Merge 2022
Terms of Use
Privacy Policy