Contacts
The Contact object is used to represent the customer, lead, or external user that a ticket is associated with.
The Contact object
Properties

idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The contact's name.

email_addressString
Optional
The contact's email address.

phone_numberString
Optional
The contact's phone number.

detailsString
Optional
The contact's details.

accountString
Optional
The contact's account.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

field_mappingsObject
Optional

modified_atString
Required
This is the datetime that this object was last updated by Merge

remote_dataRemoteData[]
Optional

The Contact object
JSON
{
"id": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"name": "Cousin Greg",
"email_address": "[email protected]",
"phone_number": "5108890293",
"details": "Executive Assistant to Tom Wambsgans",
"account": "28b54125-287f-494d-965e-3c5b330c9a68",
"remote_was_deleted": true,
Show advanced fields
}

GET
/contacts

Returns a list of Contact objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeString
Optional
If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"name": "Cousin Greg",
"email_address": "[email protected]",
"phone_number": "5108890293",
"details": "Executive Assistant to Tom Wambsgans",
"account": "28b54125-287f-494d-965e-3c5b330c9a68",
"remote_was_deleted": true,
Show advanced fields
}
]
}
Field support by platform
Dixa
Dixa

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Freshdesk
Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Freshservice
Freshservice

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Front
Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Gladly
Gladly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Gorgias
Gorgias

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


detailsString

email_addressString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Help Scout
Help Scout

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Intercom
Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Jira Service Management
Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Kustomer
Kustomer

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Re:amaze
Re:amaze

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Salesforce Service Cloud
Salesforce Service Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
ServiceNow
ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zendesk
Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zoho Desk
Zoho Desk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/contacts/{id}

Returns a Contact object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"name": "Cousin Greg",
"email_address": "[email protected]",
"phone_number": "5108890293",
"details": "Executive Assistant to Tom Wambsgans",
"account": "28b54125-287f-494d-965e-3c5b330c9a68",
"remote_was_deleted": true,
Show advanced fields
}
Field support by platform
Dixa
Dixa

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Freshdesk
Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Freshservice
Freshservice

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Front
Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Gladly
Gladly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Gorgias
Gorgias

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


detailsString

email_addressString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Help Scout
Help Scout

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Intercom
Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Jira Service Management
Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Kustomer
Kustomer

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Re:amaze
Re:amaze

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Salesforce Service Cloud
Salesforce Service Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
ServiceNow
ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zendesk
Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

detailsString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zoho Desk
Zoho Desk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Hint: Use the /linked-accounts endpoint to pull platform support information.