Main Navigation Home Getting Started Unified API Agent Handler Gateway Use Cases Quick Reference

Appearance

Sidebar Navigation

Getting Started

Overview

Architecture reference

How Merge works

Install skills

Merge Link

Quickstart

Merge Link

Overview

Magic Link

Merge Link options

Authorize single integration

Unified API

Overview

File Picker

API Basics

Overview

Authentication

Pagination

Rate limits

Merge SDKs

Sync frequency

Versioning

Data Management

Overview

Scopes

Linked Accounts

Overview

Field Mapping

Metadata

Overview

Integration Metadata

Linked Accounts

Reading Data

Overview

Syncing Data

Webhooks

Overview

Merge webhooks sent to you

Webhooks

Third-party webhooks sent to Merge

Specifications

Overview

Model Context Protocol (MCP)

Schema Properties

Supplemental Data

Overview

Custom Objects

Supplemental Data

Remote Data

Field Mapping

Overview

Access mapped data

Advanced mapping

AI data transformations

Mapping across an integration

Mapping for a Linked Account

Field Mapping

Quickstart video

Target fields

Passthrough Request

Overview

Async Passthrough

Authenticated Passthrough Request

Making a Passthrough Request

Remote Field Classes

Overview

Pulling Remote Field Classes

Pushing Remote Field Classes

Remote Field Classes

Testing

Overview

Testing Merge's Unified API via Postman

Writing Data

Overview

Programmatic Writes With Meta

Overview

Programmatic Writes with /meta

Programmatic Nested Writes with /meta

Templates and Conditional Fields

Troubleshooting Writes

Overview

Troubleshooting Writes

Writes warnings and errors reference

Writes

Overview

Async operations

Idempotency

Writes

Related and Nested Writes

API Categories

Overview

Accounting

Recruiting

Chat

Customer Relationship Management

File Storage

HR, Payroll, and Directory

Knowledge Base

Ticketing

Use Cases

Overview

Use cases

Analyze compensation

Analyze payroll runs

Analyze projects

Analyze spend

Assign trainings

Auto-provision and de-provision

Automate gifts and messages

Candidate journey (for candidates)

Candidate journey (for recruiters)

Candidate matchmaking

Career development

Collect security evidence

Contact information

Create invoices

Create purchase orders

Customer (AR) payment reconciliation

Deal notification

Employee analysis (GRC)

Enrich compliance data

Financial analysis

Forecast revenue

Headcount planning

Historic payroll

Internal database

Onboard and offboard

Opportunity recommendations

Org chart

Sales rep performance

Share specific documents

Source candidates

Source leads

Surfacing open jobs

Surface screening questions

Sync customers or suppliers

Sync expenses

Talent pool visibility

Track compliance

Track contracts

Analyze security controls

Train AI with accounting data

Train AI with ATS data

Train AI with CRM data

Train AI with HRIS data

Train AI with ticketing data

Upload contracts

Vendor (AP) payment reconciliation

Agent Handler

Overview

API overview

How it works

Overview

Quickstart

Use cases

Administer

Overview

Access Keys

Application Credentials

Billing and usage

Managing tool access

Multi-factor authentication

SCIM provisioning

Single sign-on

Team and roles

Usage API

Agent Handler

Overview

Access Keys

Overview

Regenerate access key secret

Revoke access key

Connections

Overview

Revoke Connection

Custom Regex Rules

Overview

Create custom regex rule

Create custom regex rule (Tool Pack)

Delete custom regex rule

Delete custom regex rule (Tool Pack)

Get custom regex rule

Get custom regex rule (Tool Pack)

List custom regex rules

List custom regex rules (Tool Pack)

Update custom regex rule

Update custom regex rule (Tool Pack)

Link Token

Overview

Create Link token

Mcp

Overview

MCP endpoint - list tools & call tool

Standard Entity Rules

Overview

Delete standard entity rule override (Tool Pack)

Get standard entity rule

Get standard entity rule (Tool Pack)

List standard entity rules

List standard entity rules (Tool Pack)

Update standard entity rule

Create or update standard entity rule override (Tool Pack)

Tool Description Overrides

Overview

Bulk upsert/delete tool description overrides (connector)

Bulk upsert/delete tool description overrides (Tool Pack)

List tool description overrides (Tool Pack)

Tool Packs

Overview

Update connectors in a Tool Pack (partial)

Remove a connector from a Tool Pack

List connectors in a Tool Pack

Update connectors in a Tool Pack

Tool Search

Overview

Search tools

Build

Overview

Authentication

Overview

Link

Link customization

Magic Link

CLI

Overview

Merge CLI

Connecting Agents

Overview

Custom headers for MCP

Custom MCP servers

Integrating with Copilot Studio

MCP integration

Tools

Overview

Tool Description Overrides

Tool Input Overrides

Tool Packs

Users

Overview

Companies and Groups

Registered Users

Connectors

Overview

Observe

Overview

API Request Logs

Audit Trail

Playground

Tool Call Logs

Webhooks

Resources

Overview

FAQ

Troubleshooting

Secure

Overview

Custom Regex Rules

Rule Tester

Security Gateway

Standard Entity Rules

Violations and alerts

Setup

Overview

Agent Handler for Employees

Building an agent

Local development

Gateway

Overview

API details

Get started

Install skills

Management API

API Overview

Overview

Routing

Overview

List Routing Policies

List Routing Strategies

Features

Overview

Context compression

Cost governance and savings

Management API keys

Projects

Tool calling

Web search

Multimodal

Overview

Documents

Images

Multimodal

Routing Policies

Overview

Build Your Own Router

Intelligent routing

Routing policies

Performance strategies

Priority

Single provider

Using routing policies

Use in Your IDE

Overview

Claude Code

Codex

Continue.dev

Cursor

OpenCode

Building with coding agents

Zed

Management API

Overview

Api Keys

Overview

Get an API key

Security

Overview

Audit trail

Customer blocklist

Data loss prevention

Geo-location routing

Prompt injection protection

Provider terms

Roles and permissions

Zero data retention

SOPs

Overview

Connect An Integration

First Api Call

Route Llm Requests

Set Up Agent Handler

Set Up Webhooks

Write Data With Meta

Workflows

Overview

Agent Tool Call

Authentication Flow

Data Sync

Gateway Routing

Writing Data

Quick Reference

Overview

Agent Connectors

Api Categories

Commands

Gateway Models

Troubleshooting

On this page

Fresh 2026

API Basics

Reference for API Basics in the Merge documentation.

Pages

Authentication
Pagination
Rate limits
Merge SDKs
Sync frequency
Versioning

Pager

Previous pageFile Picker

Next pageAuthentication

Unofficial documentation reference. Built for internal use.

Content summarized from the public Merge documentation.

API Basics ​

Pages ​

API Basics

Pages