Field Mapping

Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. This includes integration-wide and Linked Account specific Field Mappings. Integration-wide Field Mappings apply to all Linked Accounts in your organization for a particular integration. Linked Account level Field Mappings are specific to an end user. Learn more.

Programmatically configuring Field Mappings is only available on our Enterprise plans. View the Merge Plans to learn more.

GET
/field-mappings

https://api.merge.dev/api/hris/v1/field-mappings

US
EU
APAC

Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. Learn more.


Query & Path Parameters
exclude_remote_field_metadataBoolean
Optional
If true, remote fields metadata is excluded from each field mapping instance (i.e. remote_fields.remote_key_name and remote_fields.schema will be null). This will increase the speed of the request since these fields require some calculations.
POST
/field-mappings

https://api.merge.dev/api/hris/v1/field-mappings

US
EU
APAC

Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.


Query & Path Parameters
exclude_remote_field_metadataBoolean
Optional
If true, remote fields metadata is excluded from each field mapping instance (i.e. remote_fields.remote_key_name and remote_fields.schema will be null). This will increase the speed of the request since these fields require some calculations.
Body Parameters
target_field_nameString
Required
The name of the target field you want this remote field to map to.
target_field_descriptionString
Required
The description of the target field you want this remote field to map to.
remote_field_traversal_pathArray
Required
The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
remote_methodString
Required
The method of the remote endpoint where the remote field is coming from.
remote_url_pathString
Required
The path of the remote endpoint where the remote field is coming from.
common_model_nameString
Required
The name of the Common Model that the remote field corresponds to in a given category.
DELETE
/field-mappings/{field_mapping_id}

https://api.merge.dev/api/hris/v1/field-mappings/{field_mapping_id}

US
EU
APAC

Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.


Query & Path Parameters
field_mapping_idUUID
Required
PATCH
/field-mappings/{field_mapping_id}

https://api.merge.dev/api/hris/v1/field-mappings/{field_mapping_id}

US
EU
APAC

Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.


Query & Path Parameters
field_mapping_idUUID
Required
Body Parameters
remote_field_traversal_pathArray
Required
The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
remote_methodString
Required
The method of the remote endpoint where the remote field is coming from.
remote_url_pathString
Required
The path of the remote endpoint where the remote field is coming from.
GET
/remote-fields

https://api.merge.dev/api/hris/v1/remote-fields

US
EU
APAC

Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. Learn more.


Query & Path Parameters
common_modelsString
Optional
A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
include_example_valuesString
Optional
If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
GET
/target-fields

https://api.merge.dev/api/hris/v1/target-fields

US
EU
APAC

Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. Learn more.


Previous
Link Token
Next Up
Scopes