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

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

The Account object
JSON
{
"id": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"name": "Waystar Royco",
"domains": [
"waystar-royco.com",
"royco.com"
],
"remote_data": [
{
"path": "string",
"data": {}
}
],
"remote_was_deleted": true
}

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, 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": "Waystar Royco",
"domains": [
"waystar-royco.com",
"royco.com"
],
"remote_data": [
{
"path": "string",
"data": {}
}
],
"remote_was_deleted": true
}
]
}
Field support by platform

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

remote_idString

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

remote_idString

Intercom

Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

remote_idString

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

remote_idString

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

remote_idString

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

remote_idString

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

remote_idString

Zoho Desk

Zoho Desk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

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_data": [
{
"path": "string",
"data": {}
}
],
"remote_was_deleted": true
}
Field support by platform

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

remote_idString

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

remote_idString

Intercom

Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

remote_idString

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

remote_idString

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

remote_idString

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

remote_idString

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

remote_idString

Zoho Desk

Zoho Desk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


domainsArray

nameString

remote_dataRemoteData[]

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