Guides

Learn about interacting with Merge's Unified API and third-party platforms

Unified API Basics

Fundamentals of interacting with the Merge Unified API.
Authentication
Authenticate requests to Merge's API
Syncing Data
Efficiently pull data from Merge into your app
Rate Limits
Learn about rate limits for the Merge API
Versioning
Learn about versioning for the Merge API
Idempotency
Learn about idempotency for the Merge API
Pagination
Paginate bulk data from Merge's API
Sync Frequency
Learn about the different sync frequencies for data from third parties to Merge.
Webhooks
Use Merge's webhooks to keep your application up to date in real-time
Async Operations
Learn about asynchronous operations for the Merge API

Merge Link

Connect your users to third-party platforms.
Embedded Link
Add Link to your product
Single Integration
Direct your user to setup the configuration of a single integration
Magic Link
Integrate your end users without any frontend code

Writing Data

Write data to third-party platforms through the Merge Unified API.
Merge Writes
Write data to third-party platforms
Troubleshooting Writes
Learn about the tools used to troubleshoot POST requests

Platform and Account Metadata

Fetch integration and account metadata.
Integration Metadata
Programmatically fetch information about the integrations Merge offers
Linked Accounts
Programmatically fetch available operations for a Linked Account

Supplemental Data

Get data from third-party platforms in its original format
Remote Data
Get the latest integration data in the original format Merge received it in
Remote Field Classes
Read and write non-mapped data in a standardized format via Merge's Unified API
Custom Objects
Use Merge to interact with custom objects on your users' CRM platforms.
Passthrough Request
Make a request to the integration API using linked account credentials
Field Mapping
Map non-mapped data from your users' platforms to Merge Common Models

Testing

Learn about best practices for testing the Merge Unified API
Testing Merge’s Unified API via Postman
Best practices for testing Merge’s Unified API via Postman

Specifications

Learn about common conventions used in the Merge Unified API
Schema Properties
High-level overview of JSON Schemas returned from Merge