HomeGet StartedGuidesAPI ReferenceSDKsIntegrations
Merge.devLog inSign up
Merge API BasicsHR, Payroll, and Directory (HRIS)Recruiting (ATS)AccountingTicketingCRMMarketing AutomationFile StorageSupplemental Data
Overview
Common Models
Accounts
The Account objectGET/accountsGET/accounts/{id}
Attachments
The Attachment objectGET/attachmentsPOST/attachmentsGET/attachments/{id}GET/attachments/meta/post
Collections
The Collection objectGET/collectionsGET/collections/{id}GET/collections/{parent_id}/users
Comments
The Comment objectGET/commentsPOST/commentsGET/comments/{id}GET/comments/meta/post
Contacts
The Contact objectGET/contactsGET/contacts/{id}
ProjectsDeprecated
The Project objectGET/projectsGET/projects/{id}GET/projects/{parent_id}/users
Tags
The Tag objectGET/tagsGET/tags/{id}
Teams
The Team objectGET/teamsGET/teams/{id}
Tickets
The Ticket objectGET/ticketsPOST/ticketsGET/tickets/{id}PATCH/tickets/{id}GET/tickets/{parent_id}/collaboratorsGET/tickets/meta/patch/{id}GET/tickets/meta/postGET/tickets/remote-field-classes
Users
The User objectGET/usersGET/users/{id}
Linked Account
Account Details
Account Token
Delete Account
Issues
Linked Accounts
Link Token
Selective Sync
Data Management
Force Resync
Passthrough
Sync Status
Webhook Receivers
Common Model Scopes
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
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/product/integrations,-fast.-say-hello-to-magic-link/.

common_modelsArray
Optional
An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.

To relink an account and prevent creating a new one:

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

To disable a common model for a Linked Account:

Pass an empty array for that model's enabled_actions 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,
"common_models": [
{
"model_id": "hris.Employee",
"enabled_actions": [
"READ",
"WRITE"
],
"disabled_fields": [
"first_name"
]
}
]
}
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
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
Collections
Comments
Contacts
Projects
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

© Merge 2023
Terms of Use
Privacy Policy