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_dataRemoteData[]

Optional

remote_was_deletedBoolean

Required

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

field_mappingsObject

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_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"
    }
  }
}

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, will only return objects modified after this datetime.

modified_beforeString

Optional

If provided, will only return objects modified before this datetime.

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_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_addressString

nameString

phone_numberString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

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

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

detailsString

email_addressString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

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

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString

email_addressString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

email_addressString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

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

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

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_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_addressString

nameString

phone_numberString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

email_addressString

nameString

phone_numberString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

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

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

detailsString

email_addressString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

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

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString

email_addressString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

email_addressString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

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

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

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.

Comments

Contacts

The Contact object

Properties

/contacts

Header Parameters

Query & Path Parameters

Dixa

Freshdesk

Freshservice

Front

Gladly

Gorgias

Help Scout

Intercom

Jira Service Management

Kustomer

Re:amaze

Salesforce Service Cloud

ServiceNow

Zendesk

Zoho Desk

/contacts/{id}

Header Parameters

Query & Path Parameters

Dixa

Freshdesk

Freshservice

Front

Gladly

Gorgias

Help Scout

Intercom

Jira Service Management

Kustomer

Re:amaze

Salesforce Service Cloud

ServiceNow

Zendesk

Zoho Desk

Previous

Next Up

Get Started

API Reference