Contacts
TheContact
object is used to represent the customer, lead, or external user that a ticket is associated with.The Contact object
Properties
id
Stringremote_id
Stringname
Stringemail_address
Stringphone_number
Stringdetails
Stringaccount
Stringremote_data
RemoteData[]remote_was_deleted
Booleanfield_mappings
Object{"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_data": [{"path": "string","data": {}}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
/contacts
Returns a list of Contact
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"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_data": [{"path": "string","data": {}}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}

Dixa
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Freshdesk
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringdetails
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Freshservice
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Front
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringdetails
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Gladly
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
details
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Gorgias
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
details
Stringemail_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Help Scout
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
details
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Intercom
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Jira Service Management
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Kustomer
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Re:amaze
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Salesforce Service Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringdetails
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
ServiceNow
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringdetails
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Zendesk
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringdetails
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Zoho Desk
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String/contacts/{id}
Returns a Contact
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Boolean{"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_data": [{"path": "string","data": {}}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}

Dixa
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Freshdesk
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringdetails
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Freshservice
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Front
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringdetails
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Gladly
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
details
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Gorgias
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
details
Stringemail_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Help Scout
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
details
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Intercom
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Jira Service Management
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Kustomer
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Re:amaze
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Salesforce Service Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringdetails
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
ServiceNow
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringdetails
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Zendesk
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringdetails
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Zoho Desk
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringemail_address
Stringname
Stringphone_number
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String