For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Token-based authentication with required prefix “Bearer”
Path parameters
idstringRequiredformat: "uuid"
Headers
X-Account-TokenstringRequired
Token identifying the end user.
Query parameters
expandlist of enumsOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_remote_databooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsbooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_databooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
remote_fieldsenumOptional
Deprecated. Use show_enum_origins.
Allowed values:
show_enum_originsenumOptional
A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. Learn more
Allowed values:
Response
idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
namestring or nullOptional
The contact's name.
is_supplierboolean or nullOptional
Whether the contact is a supplier.
is_customerboolean or nullOptional
Whether the contact is a customer.
email_addressstring or nullOptional
The contact's email address.
tax_numberstring or nullOptional
The contact's tax number.
statusenum or nullOptional
The contact’s status. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=status to receive the integration’s own value instead.
Allowed values:
currencystring or nullOptional
The currency the contact's transactions are in.
remote_updated_atdatetime or nullOptional
When the third party's contact was updated.
companystring or nullOptionalformat: "uuid"
The company the contact belongs to.
addresseslist of objectsOptional
Address object IDs for the given Contacts object.
phone_numberslist of objectsOptional
AccountingPhoneNumber object for the given Contacts object.
contact_urlstring or nullOptionalformat: "uri"<=2000 characters
The 3rd party URL of the contact.
remote_was_deletedbooleanOptionalRead-only
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
