Contacts
The
Contact object is used to represent the customer, lead, or external user that a ticket is associated with.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
nameStringThe contact's name.
email_addressStringThe contact's email address.
phone_numberStringThe contact's phone number.
detailsStringThe contact's details.
accountUUIDThe contact's account.
remote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/contacts
https://api.merge.dev/api/ticketing/v1/contacts
US
EU
APAC
Returns a list of Contact objects.
Query & path parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
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.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Dixa
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Freshdesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDdetailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Freshservice
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Front
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDdetailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Gladly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
detailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Gorgias
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
detailsStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Help Scout
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
detailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Intercom
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Jira Service Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Kustomer
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Re:amaze
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
detailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Salesforce Service Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDdetailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
ServiceNow
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDdetailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Zendesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDdetailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idString
Zoho Desk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringPOST
/contacts
https://api.merge.dev/api/ticketing/v1/contacts
US
EU
APAC
Creates a Contact object with the given values.
Query & path parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.nameStringThe contact's name.
email_addressStringThe contact's email address.
phone_numberStringThe contact's phone number.
detailsStringThe contact's details.
accountUUIDThe contact's account. Must pass in a valid Merge ID, which can be obtained from the
id field in the Account object.integration_paramsObjectlinked_account_paramsObjectField support by integration
Use the /linked-accounts endpoint to pull platform support information
Intercom
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
email_addressStringRequired
nameStringOptional
phone_numberStringOptional
remote_idStringOptional
Zendesk
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
email_addressStringRequired
nameStringOptional
remote_idStringOptional
To include the correct model fields when making POST requests, use the GET /contacts/meta/post endpoint. Learn more in our /meta guide.
GET
/contacts/{id}
https://api.merge.dev/api/ticketing/v1/contacts/{id}
US
EU
APAC
Returns a Contact object with the given id.
Query & path parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Dixa
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringFreshdesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDdetailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringFreshservice
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringFront
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDdetailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringGladly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
detailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringGorgias
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
detailsStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringHelp Scout
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
detailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringIntercom
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringJira Service Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringKustomer
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringRe:amaze
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
detailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringSalesforce Service Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDdetailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringServiceNow
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDdetailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringZendesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDdetailsStringemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringZoho Desk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDemail_addressStringnameStringphone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringGET
/contacts/meta/post
https://api.merge.dev/api/ticketing/v1/contacts/meta/post
US
EU
APAC
Returns metadata for TicketingContact POSTs.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Intercom
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
email_addressStringRequired
nameStringOptional
phone_numberStringOptional
remote_idStringOptional
Zendesk
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
email_addressStringRequired
nameStringOptional
remote_idStringOptional