Merge Ticketing - Accounts

Accounts

The Account object is used to represent the account that a ticket is associated with.

The account is a company that may be a customer. This does not represent the company that is receiving the ticket.

The Account object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

nameString

Optional

The account's name.

domainsArray

Optional

The account's domain names.

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 Account object

JSON


{
  "id": "17a54124-287f-494d-965e-3c5b330c9a68",
  "remote_id": "19202938",
  "name": "Waystar Royco",
  "domains": [
    "waystar-royco.com",
    "royco.com"
  ],
  "remote_was_deleted": true,
Show advanced fields
}

GET

/accounts

Returns a list of Account 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.

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": "Waystar Royco",
      "domains": [
        "waystar-royco.com",
        "royco.com"
      ],
      "remote_was_deleted": true,
Show advanced fields
    }
  ]
}

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

domainsArray

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

domainsArray

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

domainsArray

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Kustomer

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Salesforce Service Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

domainsArray

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

domainsArray

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

domainsArray

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Zoho Desk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

domainsArray

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

GET

/accounts/{id}

Returns an Account 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

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": "Waystar Royco",
  "domains": [
    "waystar-royco.com",
    "royco.com"
  ],
  "remote_was_deleted": true,
Show advanced fields
}