Merge

Merge Subpackage Field Mapping API

The subpackage_fieldMapping API from Merge — 30 operation(s) for subpackage_fieldmapping.

GitHub OpenAPI

Operations 50

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /accounting/v1/field-mappings List field mappings on an accounting linked account · Field Mappings Retrieve #
Ask an LLM
“Which custom field mappings are set up on my customer's accounting connection?”
“Can I see how remote accounting fields map onto my own Merge fields?”
Tell an agent
Show every field mapping on the accounting linked account with token {account_token}.
List accounting field mappings without the remote field metadata {exclude_remote_field_metadata}.
POST /accounting/v1/field-mappings Map a remote accounting field to a target field · Field Mappings Create #
Ask an LLM
“How do I pull a custom field out of a customer's accounting system into a common model?”
“Does adding an accounting field mapping force a full resync of the ledger data?”
Tell an agent
Map the remote accounting field at {remote_field_traversal_path} from {remote_method} {remote_url_path} onto {common_model_name}.
Create accounting target field {target_field_name} on {common_model_name} fed from {remote_url_path} via {remote_method} at path {remote_field_traversal_path}.
DELETE /accounting/v1/field-mappings/{field_mapping_id} Delete an accounting field mapping · Field Mappings Destroy #
Ask an LLM
“What happens to synced ledger data when I remove an accounting field mapping?”
“Can I drop a custom mapping from one customer's accounting connection?”
Tell an agent destructive · confirm first
Delete accounting field mapping {field_mapping_id}.
Remove mapping {field_mapping_id} from the bookkeeping integration and its mapped data.
PATCH /accounting/v1/field-mappings/{field_mapping_id} Change an existing accounting field mapping · Field Mappings Partial Update #
Ask an LLM
“Can I repoint an accounting field mapping at a different remote endpoint?”
“Is it possible to edit the JMESPath on a ledger field mapping I already made?”
Tell an agent
Point accounting field mapping {field_mapping_id} at remote path {remote_url_path}.
Set the JMES path of accounting mapping {field_mapping_id} to {jmes_path}.
GET /accounting/v1/remote-fields List remote fields available from an accounting integration · Remote Fields Retrieve #
Ask an LLM
“Which raw fields does my customer's accounting platform expose that I could map?”
“Can I get example values for the remote fields on accounting invoices?”
Tell an agent
List remote accounting fields for the {common_models} models.
Show accounting remote fields with example values {include_example_values}.
GET /accounting/v1/target-fields List organization-wide accounting target fields · Target Fields Retrieve #
Ask an LLM
“What organization-wide target fields have we defined for accounting data?”
“Which custom accounting fields apply across all of our linked accounts?”
Tell an agent
List our org-wide accounting target fields using account token {account_token}.
Show every accounting target field our organization has defined.
POST /accounting/v1/target-fields Define a new accounting target field · Target Fields Create #
Ask an LLM
“How do I add a custom field to accounting data for every customer at once?”
“Can I describe what a new org-wide accounting target field is for?”
Tell an agent
Create accounting target field {name} on the {common_model} model.
Add an org-wide accounting field {name} to {common_model} described as {description}.
GET /ats/v1/field-mappings List field mappings on a recruiting linked account · Field Mappings Retrieve #
Ask an LLM
“What field mappings exist on this customer's applicant tracking connection?”
“Which candidate and job fields have been custom-mapped for this ATS integration?”
Tell an agent
Get the ATS field mappings for linked account token {account_token}.
Fetch recruiting field mappings, excluding remote metadata {exclude_remote_field_metadata}.
POST /ats/v1/field-mappings Map a remote ATS field to a target field · Field Mappings Create #
Ask an LLM
“Can I bring a custom candidate field from an applicant tracking system into my data?”
“Will a new recruiting field mapping resync every job and candidate from scratch?”
Tell an agent
Create an ATS mapping from {remote_method} {remote_url_path} field {remote_field_traversal_path} into model {common_model_name}.
Add recruiting field {target_field_name} to {common_model_name}, sourced from {remote_field_traversal_path} on {remote_method} {remote_url_path}.
DELETE /ats/v1/field-mappings/{field_mapping_id} Delete a recruiting field mapping · Field Mappings Destroy #
Ask an LLM
“If I delete an ATS field mapping, is the candidate data it pulled removed too?”
“How can I get rid of a recruiting field mapping I no longer need?”
Tell an agent destructive · confirm first
Delete ATS field mapping {field_mapping_id}.
Tear down the applicant tracking mapping {field_mapping_id}.
PATCH /ats/v1/field-mappings/{field_mapping_id} Change an existing ATS field mapping · Field Mappings Partial Update #
Ask an LLM
“Can I change which remote candidate field an existing ATS mapping reads?”
“Is there a way to edit the HTTP method on a recruiting field mapping?”
Tell an agent
Update ATS mapping {field_mapping_id} to read {remote_field_traversal_path}.
Switch recruiting mapping {field_mapping_id} to use remote method {remote_method}.
GET /ats/v1/remote-fields List remote fields available from an ATS integration · Remote Fields Retrieve #
Ask an LLM
“What third-party candidate fields could I map from this applicant tracking system?”
“Does the ATS remote field list show sample values?”
Tell an agent
List the ATS remote fields for common models {common_models}.
Show recruiting remote fields including example values {include_example_values}.
GET /ats/v1/target-fields List organization-wide ATS target fields · Target Fields Retrieve #
Ask an LLM
“Which organization-level custom fields have we set up for recruiting data?”
“Where do I see the ATS target fields shared by all our customers?”
Tell an agent
Show the ATS target fields for the linked account token {account_token}.
List our organization's recruiting target fields.
POST /ats/v1/target-fields Define a new ATS target field · Target Fields Create #
Ask an LLM
“Can I define a custom recruiting field that applies to every linked ATS?”
“What do I need to create an organization-wide candidate or job target field?”
Tell an agent
Create an ATS target field {name} on {common_model}.
Define recruiting field {name} for model {common_model} with the note {description}.
GET /field-mappings List field mappings on a chat linked account · Field Mappings Retrieve #
Ask an LLM
“Which field mappings are configured on my customer's chat integration?”
“Can I review the custom mappings for messages and conversations from a chat tool?”
Tell an agent
List chat field mappings for account token {account_token}.
Pull the chat integration's field mappings, remote metadata excluded {exclude_remote_field_metadata}.
POST /field-mappings Map a remote chat field to a target field · Field Mappings Create #
Ask an LLM
“How can I sync a custom field from a chat platform's messages into my model?”
“Does creating a chat field mapping trigger a complete resync of conversations?”
Tell an agent
Map chat remote field {remote_field_traversal_path} from {remote_method} {remote_url_path} to {common_model_name}.
Add chat target {target_field_name} on {common_model_name} fed by {remote_method} {remote_url_path} path {remote_field_traversal_path}.
DELETE /field-mappings/{field_mapping_id} Delete a chat field mapping · Field Mappings Destroy #
Ask an LLM
“Can I remove a custom field mapping from a chat integration?”
“Does deleting a chat mapping also wipe the message data it synced?”
Tell an agent destructive · confirm first
Delete chat field mapping {field_mapping_id}.
Get rid of the messaging mapping {field_mapping_id} on this chat connection.
PATCH /field-mappings/{field_mapping_id} Change an existing chat field mapping · Field Mappings Partial Update #
Ask an LLM
“Can I edit where a chat field mapping reads its value from?”
“Is an advanced mapping expression supported when updating a chat mapping?”
Tell an agent
Change chat mapping {field_mapping_id} to remote URL path {remote_url_path}.
Apply advanced expression {advanced_mapping_expression} to chat mapping {field_mapping_id}.
GET /remote-fields List remote fields available from a chat integration · Remote Fields Retrieve #
Ask an LLM
“What raw message and conversation fields does a customer's chat tool expose?”
“Can I filter the chat remote fields to one common model?”
Tell an agent
List chat remote fields for models {common_models}.
Show the chat integration's remote fields with samples {include_example_values}.
GET /target-fields List organization-wide chat target fields · Target Fields Retrieve #
Ask an LLM
“Which org-wide custom fields have we defined for chat data?”
“Where are the chat target fields that every linked account shares?”
Tell an agent
List chat target fields via account token {account_token}.
Show all organization-wide chat target fields.
POST /target-fields Define a new chat target field · Target Fields Create #
Ask an LLM
“Can I add a custom chat field that every customer's integration can map to?”
“What's needed to define an org-wide target field on chat messages?”
Tell an agent
Create chat target field {name} on model {common_model}.
Define an org-wide chat field {name} for {common_model}, explained as {description}.
GET /crm/v1/field-mappings List field mappings on a CRM linked account · Field Mappings Retrieve #
Ask an LLM
“Which custom CRM fields are mapped for this customer's sales system?”
“Can I audit the field mappings on a CRM connection in Merge?”
Tell an agent
List CRM field mappings for linked account token {account_token}.
Return the CRM field mappings with remote metadata excluded {exclude_remote_field_metadata}.
POST /crm/v1/field-mappings Map a remote CRM field to a target field · Field Mappings Create #
Ask an LLM
“How do I sync a custom contact or deal field from a customer's CRM?”
“Will a new CRM field mapping resync all accounts and opportunities from the start?”
Tell an agent
Map CRM field {remote_field_traversal_path} returned by {remote_method} {remote_url_path} into {common_model_name}.
Create CRM target {target_field_name} for {common_model_name} from {remote_method} {remote_url_path} at {remote_field_traversal_path}.
DELETE /crm/v1/field-mappings/{field_mapping_id} Delete a CRM field mapping · Field Mappings Destroy #
Ask an LLM
“How can I unmap a custom CRM field for one customer?”
“Is the synced sales data deleted when a CRM field mapping goes away?”
Tell an agent destructive · confirm first
Delete CRM field mapping {field_mapping_id}.
Remove the sales CRM mapping {field_mapping_id} along with its mapped values.
PATCH /crm/v1/field-mappings/{field_mapping_id} Change an existing CRM field mapping · Field Mappings Partial Update #
Ask an LLM
“Can I fix the remote path on a CRM field mapping without recreating it?”
“Is it possible to change a CRM mapping's JMESPath expression?”
Tell an agent
Edit CRM mapping {field_mapping_id} so it reads {remote_field_traversal_path}.
Give CRM mapping {field_mapping_id} the JMES path {jmes_path}.
GET /crm/v1/remote-fields List remote fields available from a CRM integration · Remote Fields Retrieve #
Ask an LLM
“What custom fields in my customer's CRM are available to map?”
“Can I see example values for remote CRM contact fields?”
Tell an agent
List CRM remote fields for {common_models}.
Show the sales CRM's remote fields and their example values {include_example_values}.
GET /crm/v1/target-fields List organization-wide CRM target fields · Target Fields Retrieve #
Ask an LLM
“Which CRM target fields has our organization defined for every customer?”
“What org-level custom CRM fields exist today?”
Tell an agent
Show CRM target fields for account token {account_token}.
List our organization-wide CRM target fields.
POST /crm/v1/target-fields Define a new CRM target field · Target Fields Create #
Ask an LLM
“Can I create one custom CRM field, like lead score, for all linked accounts?”
“How is an org-wide CRM target field attached to a common model?”
Tell an agent
Create CRM target field {name} on {common_model}.
Define org-wide CRM field {name} for {common_model} with description {description}.
GET /filestorage/v1/field-mappings List field mappings on a file storage linked account · Field Mappings Retrieve #
Ask an LLM
“Which custom file and folder fields are mapped on this storage connection?”
“Can I list the field mappings for a customer's file storage integration?”
Tell an agent
List file storage field mappings for token {account_token}.
Get storage field mappings, leaving out remote metadata {exclude_remote_field_metadata}.
POST /filestorage/v1/field-mappings Map a remote file storage field to a target field · Field Mappings Create #
Ask an LLM
“How can I pull a custom file attribute from a storage provider into my model?”
“Does a new file storage mapping make every file and folder resync?”
Tell an agent
Map storage field {remote_field_traversal_path} from {remote_method} {remote_url_path} onto {common_model_name}.
Create file storage target {target_field_name} on {common_model_name} using {remote_method} {remote_url_path} and path {remote_field_traversal_path}.
DELETE /filestorage/v1/field-mappings/{field_mapping_id} Delete a file storage field mapping · Field Mappings Destroy #
Ask an LLM
“Can I delete a custom mapping on a file storage connection?”
“What happens to file metadata synced by a storage mapping once it is deleted?”
Tell an agent destructive · confirm first
Delete file storage field mapping {field_mapping_id}.
Drop storage mapping {field_mapping_id} for files and folders.
PATCH /filestorage/v1/field-mappings/{field_mapping_id} Change an existing file storage field mapping · Field Mappings Partial Update #
Ask an LLM
“Can I retarget a file storage mapping to another remote endpoint?”
“How do I tweak the traversal path of a storage field mapping?”
Tell an agent
Update storage mapping {field_mapping_id} to call {remote_url_path}.
Change the traversal path on file storage mapping {field_mapping_id} to {remote_field_traversal_path}.
GET /filestorage/v1/remote-fields List remote fields available from a file storage integration · Remote Fields Retrieve #
Ask an LLM
“What remote file and drive fields can I map from a storage provider?”
“Can I see sample values for file storage remote fields?”
Tell an agent
List file storage remote fields for {common_models}.
Show storage remote fields with example values {include_example_values}.
GET /filestorage/v1/target-fields List organization-wide file storage target fields · Target Fields Retrieve #
Ask an LLM
“Which org-wide target fields have we defined for files and folders?”
“Where can I find our file storage target field definitions?”
Tell an agent
List file storage target fields using token {account_token}.
Show every organization-wide target field for file storage.
POST /filestorage/v1/target-fields Define a new file storage target field · Target Fields Create #
Ask an LLM
“Can I add a custom field to files or folders for all customers at once?”
“What do I pass to create an org-wide file storage target field?”
Tell an agent
Create file storage target field {name} on {common_model}.
Add storage field {name} to the {common_model} model, described {description}.
GET /hris/v1/field-mappings List field mappings on an HRIS linked account · Field Mappings Retrieve #
Ask an LLM
“Which custom employee fields are mapped on this customer's HR system?”
“Can I review the HRIS field mappings for a payroll or HR connection?”
Tell an agent
List HRIS field mappings for token {account_token}.
Fetch HR field mappings without remote metadata {exclude_remote_field_metadata}.
POST /hris/v1/target-fields Define a new HRIS target field · Target Fields Create #
Ask an LLM
“Can I define a custom employee field that every HR integration maps into?”
“How is an organization-wide HRIS target field created?”
Tell an agent
Create HRIS target field {name} on {common_model}.
Define HR field {name} for model {common_model} with description {description}.
GET /knowledgebase/v1/field-mappings List field mappings on a knowledge base linked account · Field Mappings Retrieve #
Ask an LLM
“Which article fields are custom-mapped on this knowledge base connection?”
“Can I list field mappings for a customer's help center integration?”
Tell an agent
List knowledge base field mappings for token {account_token}.
Show knowledge base mappings excluding remote metadata {exclude_remote_field_metadata}.
POST /knowledgebase/v1/field-mappings Map a remote knowledge base field to a target field · Field Mappings Create #
Ask an LLM
“How do I sync a custom article field from a knowledge base into my model?”
“Does a knowledge base mapping need a target field name and description?”
Tell an agent
Create knowledge base field {name} ({desc}) on {model} from {method} {url} at {path}.
Map article field {path} into knowledge base target {name}, meaning {desc}, on {model} via {method} {url}.
DELETE /knowledgebase/v1/field-mappings/{field_mapping_id} Delete a knowledge base field mapping · Field Mappings Destroy #
Ask an LLM
“Can I remove a custom field mapping from a knowledge base integration?”
“Is mapped article data deleted along with the knowledge base mapping?”
Tell an agent destructive · confirm first
Delete knowledge base field mapping {field_mapping_id}.
Remove help center article mapping {field_mapping_id}.
PATCH /knowledgebase/v1/field-mappings/{field_mapping_id} Change an existing knowledge base field mapping · Field Mappings Partial Update #
Ask an LLM
“Can I change the remote method on a knowledge base field mapping?”
“How do I adjust which article field a knowledge base mapping reads?”
Tell an agent
Set knowledge base mapping {field_mapping_id} to remote method {remote_method}.
Repoint article mapping {field_mapping_id} at traversal path {remote_field_traversal_path}.
GET /knowledgebase/v1/remote-fields List remote fields from a knowledge base integration · Remote Fields Retrieve #
Ask an LLM
“What raw article and container fields can I map from a knowledge base?”
“Can the knowledge base remote field list include sample values?”
Tell an agent
List knowledge base remote fields for {common_models}.
Show help center remote fields with example values {include_example_values}.
GET /knowledgebase/v1/target-fields List organization-wide knowledge base target fields · Target Fields Retrieve #
Ask an LLM
“Which org-wide target fields exist for knowledge base articles?”
“What custom knowledge base fields have we defined across customers?”
Tell an agent
List knowledge base target fields for token {account_token}.
Show our organization's knowledge base target fields.
GET /ticketing/v1/field-mappings List field mappings on a ticketing linked account · Field Mappings Retrieve #
Ask an LLM
“Which custom ticket fields are mapped for this customer's helpdesk?”
“Can I see the field mappings set up on a ticketing connection?”
Tell an agent
List ticketing field mappings for token {account_token}.
Show helpdesk field mappings without remote metadata {exclude_remote_field_metadata}.
POST /ticketing/v1/field-mappings Map a remote ticketing field to a target field · Field Mappings Create #
Ask an LLM
“How do I sync a custom ticket field from a customer's helpdesk?”
“Will adding a ticketing mapping resync every ticket from the beginning?”
Tell an agent
Map ticket field {remote_field_traversal_path} from {remote_method} {remote_url_path} into {common_model_name}.
Create ticketing target {target_field_name} on {common_model_name} fed from {remote_method} {remote_url_path} at {remote_field_traversal_path}.
DELETE /ticketing/v1/field-mappings/{field_mapping_id} Delete a ticketing field mapping · Field Mappings Destroy #
Ask an LLM
“Can I delete a custom ticket field mapping for one helpdesk connection?”
“Does removing a ticketing mapping delete the ticket data it synced?”
Tell an agent destructive · confirm first
Delete ticketing field mapping {field_mapping_id}.
Remove helpdesk mapping {field_mapping_id} and its mapped ticket values.
PATCH /ticketing/v1/field-mappings/{field_mapping_id} Change an existing ticketing field mapping · Field Mappings Partial Update #
Ask an LLM
“Can I edit the remote URL a ticketing field mapping pulls from?”
“Is a JMESPath change allowed on a ticket field mapping I already created?”
Tell an agent
Update ticketing mapping {field_mapping_id} to remote path {remote_url_path}.
Set JMES path {jmes_path} on helpdesk mapping {field_mapping_id}.
GET /ticketing/v1/remote-fields List remote fields available from a ticketing integration · Remote Fields Retrieve #
Ask an LLM
“What raw ticket fields does a customer's helpdesk expose for mapping?”
“Can I get example values for remote ticketing fields?”
Tell an agent
List ticketing remote fields for {common_models}.
Show helpdesk remote fields with example values {include_example_values}.
GET /ticketing/v1/target-fields List organization-wide ticketing target fields · Target Fields Retrieve #
Ask an LLM
“Which org-wide target fields have we defined for tickets?”
“What custom ticketing fields apply across every linked helpdesk?”
Tell an agent
List ticketing target fields with token {account_token}.
Show all organization-wide ticketing target fields.
POST /ticketing/v1/target-fields Define a new ticketing target field · Target Fields Create #
Ask an LLM
“Can I add a custom ticket field that all helpdesk integrations map into?”
“What does it take to define an org-wide ticketing target field?”
Tell an agent
Create ticketing target field {name} on {common_model}.
Define helpdesk field {name} for {common_model}, described as {description}.

Documentation

📖
Documentation
https://docs.merge.dev/merge-unified/hris/overview
📖
Documentation
https://docs.merge.dev/merge-unified/ats/overview
📖
Documentation
https://docs.merge.dev/merge-unified/accounting/overview
📖
Documentation
https://docs.merge.dev/merge-unified/ticketing/overview
📖
Documentation
https://docs.merge.dev/merge-unified/crm/overview
📖
Documentation
https://docs.merge.dev/merge-unified/filestorage/overview
📖
Documentation
https://docs.merge.dev/merge-unified/knowledge-base/overview
📖
Documentation
https://docs.merge.dev/merge-unified/chat/overview
📖
Documentation
https://docs.merge.dev/merge-agent-handler/agent-handler
📖
Documentation
https://docs.merge.dev/merge-gateway/api-overview

Specifications

⚙
OpenAPI
https://artifacts.apis.io/merge/openapi/merge-subpackage-fieldmapping-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/hris-api-employee-schema.json
📊
JSONStructure
https://artifacts.apis.io/merge/json-structure/hris-api-employee-structure.json
📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/ats-api-candidate-schema.json
📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/ats-api-application-schema.json
📊
JSONStructure
https://artifacts.apis.io/merge/json-structure/ats-api-candidate-structure.json
📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/accounting-api-invoice-schema.json
📊
JSONStructure
https://artifacts.apis.io/merge/json-structure/accounting-api-invoice-structure.json
📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/ticketing-api-ticket-schema.json
📊
JSONStructure
https://artifacts.apis.io/merge/json-structure/ticketing-api-ticket-structure.json
📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/crm-api-opportunity-schema.json
📊
JSONStructure
https://artifacts.apis.io/merge/json-structure/crm-api-opportunity-structure.json
📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/file-storage-api-file-schema.json
📊
JSONStructure
https://artifacts.apis.io/merge/json-structure/file-storage-api-file-structure.json
📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/knowledge-base-api-article-schema.json
📊
JSONStructure
https://artifacts.apis.io/merge/json-structure/knowledge-base-api-article-structure.json
📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/chat-api-message-schema.json
📊
JSONStructure
https://artifacts.apis.io/merge/json-structure/chat-api-message-structure.json
📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/agent-handler-tool-pack-schema.json
📊
JSONStructure
https://artifacts.apis.io/merge/json-structure/agent-handler-tool-pack-structure.json
📊
JSONSchema
https://artifacts.apis.io/merge/json-schema/gateway-response-schema.json
📊
JSONStructure
https://artifacts.apis.io/merge/json-structure/gateway-response-structure.json

Other Resources

🔗
Website
https://www.merge.dev/categories/hr-payroll-api
🔗
JSONLD
https://artifacts.apis.io/merge/json-ld/merge-hris-api-context.jsonld
🔗
Examples
https://artifacts.apis.io/merge/examples/hris-api-employee-example.json
🔗
Website
https://www.merge.dev/categories/ats-recruiting-api
🔗
JSONLD
https://artifacts.apis.io/merge/json-ld/merge-ats-api-context.jsonld
🔗
Examples
https://artifacts.apis.io/merge/examples/ats-api-candidate-example.json
🔗
Examples
https://artifacts.apis.io/merge/examples/ats-api-application-example.json
🔗
Website
https://www.merge.dev/categories/accounting-api
🔗
JSONLD
https://artifacts.apis.io/merge/json-ld/merge-accounting-api-context.jsonld
🔗
Examples
https://artifacts.apis.io/merge/examples/accounting-api-invoice-example.json
🔗
Website
https://www.merge.dev/categories/ticketing-api
🔗
JSONLD
https://artifacts.apis.io/merge/json-ld/merge-ticketing-api-context.jsonld
🔗
Examples
https://artifacts.apis.io/merge/examples/ticketing-api-ticket-example.json
🔗
Website
https://www.merge.dev/categories/crm-api
🔗
JSONLD
https://artifacts.apis.io/merge/json-ld/merge-crm-api-context.jsonld
🔗
Examples
https://artifacts.apis.io/merge/examples/crm-api-opportunity-example.json
🔗
Website
https://www.merge.dev/categories/file-storage-api
🔗
JSONLD
https://artifacts.apis.io/merge/json-ld/merge-file-storage-api-context.jsonld
🔗
Examples
https://artifacts.apis.io/merge/examples/file-storage-api-file-example.json
🔗
Website
https://www.merge.dev/categories/knowledge-base
🔗
JSONLD
https://artifacts.apis.io/merge/json-ld/merge-knowledge-base-api-context.jsonld
🔗
Examples
https://artifacts.apis.io/merge/examples/knowledge-base-api-article-example.json
🔗
Website
https://www.merge.dev/categories/chat
🔗
JSONLD
https://artifacts.apis.io/merge/json-ld/merge-chat-api-context.jsonld
🔗
Examples
https://artifacts.apis.io/merge/examples/chat-api-message-example.json
🔗
Website
https://www.merge.dev/merge-agent-handler
🔗
JSONLD
https://artifacts.apis.io/merge/json-ld/merge-agent-handler-context.jsonld
🔗
Examples
https://artifacts.apis.io/merge/examples/agent-handler-tool-pack-example.json
🔗
Support
https://help.ah.merge.dev/
🔗
Website
https://www.merge.dev/gateway
🔗
JSONLD
https://artifacts.apis.io/merge/json-ld/merge-gateway-context.jsonld
🔗
Examples
https://artifacts.apis.io/merge/examples/gateway-response-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/merge:merge-subpackage-fieldmapping-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

merge-subpackage-fieldmapping-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Merge Subpackage Field Mapping API
  version: 1.0.0
  description: 'Operations tagged subpackage_fieldMapping across 8 of this provider''s published API definitions: merge-accounting-api-openapi.yaml, merge-ats-api-openapi.yaml, merge-chat-api-openapi.yaml, merge-crm-api-openapi.yaml, merge-file-storage-api-openapi.yaml, merge-hris-api-openapi.yaml, merge-knowledge-base-api-openapi.yaml, merge-ticketing-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.merge.dev/api
- url: https://api-eu.merge.dev/api
- url: https://api-ap.merge.dev/api
- url: https://api.merge.dev/api/chat/v1
- url: https://api-eu.merge.dev/api/chat/v1
- url: https://api-ap.merge.dev/api/chat/v1
- url: https://api-ap.merge.dev/api/knowledgebase/v1
tags:


# --- truncated at 32 KB (120 KB total) ---
# Full source: https://artifacts.apis.io/merge/openapi/merge-subpackage-fieldmapping-api-openapi.yml