Tags

The Tag object is used to represent a tag or label for a ticket.

The Tag object

Properties

remote_idString
Optional
The third-party API ID of the matching object.
nameString
Optional
The tag's name.
remote_dataRemoteData[]
Optional
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
The Tag object
JSON
{
  "remote_id": "19202938",
  "name": "Ticketing API",
  "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

/tags

Returns a list of Tag 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": [
    {
      "remote_id": "19202938",
      "name": "Ticketing API",
      "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"
        }
      }
    }
  ]
}
Field support by platform

Asana

Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Azure DevOps

Azure DevOps

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

GitHub Issues

GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

GitLab

GitLab

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Gorgias

Gorgias

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Help Scout

Help Scout

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Intercom

Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Jira

Jira

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Kustomer

Kustomer

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Linear

Linear

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Pivotal Tracker

Pivotal Tracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Re:amaze

Re:amaze

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Zoho BugTracker

Zoho BugTracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Zoho Desk

Zoho Desk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Ironclad

Ironclad

Coming Soon
Salesforce Service Cloud

Salesforce Service Cloud

Coming Soon
Targetprocess

Targetprocess

Coming Soon
Workfront

Workfront

Coming Soon
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/tags/{id}

Returns a Tag 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
{
  "remote_id": "19202938",
  "name": "Ticketing API",
  "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"
    }
  }
}
Field support by platform

Asana

Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Azure DevOps

Azure DevOps

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

GitHub Issues

GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

GitLab

GitLab

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Gorgias

Gorgias

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Help Scout

Help Scout

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Intercom

Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Jira

Jira

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Kustomer

Kustomer

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Linear

Linear

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Pivotal Tracker

Pivotal Tracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Re:amaze

Re:amaze

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Zoho BugTracker

Zoho BugTracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Zoho Desk

Zoho Desk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Ironclad

Ironclad

Coming Soon
Salesforce Service Cloud

Salesforce Service Cloud

Coming Soon
Targetprocess

Targetprocess

Coming Soon
Workfront

Workfront

Coming Soon
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Projects

Next Up

Teams